feat: Updated requiredParameters to identifyingParameters

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.138",
+  "version": "1.0.141",
   "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.64",
+    "codify-schemas": "1.0.70",
     "@npmcli/promise-spawn": "^7.0.1",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "uuid": "^10.0.0",

package.json

@@ -241,7 +241,7 @@ describe('Plan entity tests', () => {
             propB: { type: 'string', canModify: true },
           },
           allowMultiple: {
-            requiredParameters: ['propA']
+            identifyingParameters: ['propA']
           }
         }
       }

src/plan/plan.test.ts

@@ -263,7 +263,7 @@ export class Plan<T extends StringIndexedObject> {
     const matcher = typeof settings.allowMultiple === 'boolean' || !settings.allowMultiple.matcher
       ? ((desired: Partial<T>, currentArr: Array<Partial<T>>) => {
         const requiredParameters = typeof settings.allowMultiple === 'object'
-          ? settings.allowMultiple?.requiredParameters ?? (settings.schema?.required as string[]) ?? []
+          ? settings.allowMultiple?.identifyingParameters ?? (settings.schema?.required as string[]) ?? []
           : (settings.schema?.required as string[]) ?? []
 
         const matched = currentArr.filter((c) => requiredParameters.every((key) => {

src/plan/plan.ts

@@ -324,4 +324,46 @@ describe('Plugin tests', () => {
 
     console.log(result);
   })
+
+  it('Returns allowMultiple for getResourceInfo', async () => {
+    const resource = spy(new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          ...super.getSettings(),
+          allowMultiple: {
+            identifyingParameters: ['path', 'paths']
+          }
+        }
+      }
+    })
+
+    const testPlugin = Plugin.create('testPlugin', [resource as any]);
+
+    const resourceInfo = await testPlugin.getResourceInfo({
+      type: 'testResource',
+    })
+
+    expect(resourceInfo.allowMultiple?.requiredParameters).toMatchObject([
+      'path', 'paths'
+    ])
+  })
+
+  it('Returns an empty array by default for allowMultiple for getResourceInfo', async () => {
+    const resource = spy(new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          ...super.getSettings(),
+          allowMultiple: true
+        }
+      }
+    })
+
+    const testPlugin = Plugin.create('testPlugin', [resource as any]);
+
+    const resourceInfo = await testPlugin.getResourceInfo({
+      type: 'testResource',
+    })
+
+    expect(resourceInfo.allowMultiple?.requiredParameters).toMatchObject([])
+  })
 });

src/plugin/plugin.test.ts

@@ -74,8 +74,8 @@ export class Plugin {
 
     const allowMultiple = resource.settings.allowMultiple !== undefined
       ? (typeof resource.settings.allowMultiple === 'boolean'
-          ? { requiredParameters: schema?.required ?? [] }
-          : { requiredParameters: resource.settings.allowMultiple.requiredParameters ?? schema?.required ?? [] }
+          ? { identifyingParameters: schema?.required ?? [] }
+          : { identifyingParameters: resource.settings.allowMultiple.identifyingParameters ?? schema?.required ?? [] }
       ) : undefined
 
     return {
@@ -84,6 +84,10 @@ export class Plugin {
       dependencies: resource.dependencies,
       schema: schema as Record<string, unknown> | undefined,
       importAndDestroy: {
+        preventImport: resource.settings.importAndDestroy?.preventImport,
+        requiredParameters: requiredPropertyNames,
+      },
+      import: {
         requiredParameters: requiredPropertyNames,
       },
       allowMultiple

src/plugin/plugin.ts

@@ -214,6 +214,10 @@ export class ResourceController<T extends StringIndexedObject> {
     core: ResourceConfig,
     parameters: Partial<T>
   ): Promise<Array<ResourceJson> | null> {
+    if (this.settings.importAndDestroy?.preventImport) {
+      throw new Error(`Type: ${this.typeId} cannot be imported`);
+    }
+
     this.addDefaultValues(parameters);
     await this.applyTransformParameters(parameters);
 

src/resource/resource-controller.ts

@@ -42,7 +42,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.
      */
-    requiredParameters?: string[]
+    identifyingParameters?: string[]
 
     /**
      * If multiple copies are allowed then a matcher must be defined to match the desired
@@ -103,6 +103,13 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    * ```
    */
   importAndDestroy?: {
+    /**
+     * Can this resources be imported? If set to false then the codifyCLI will skip over/not consider this
+     * resource valid for imports. Defaults to true.
+     *
+     * Resources that can't be imported in the core library for example are: action resources
+     */
+    preventImport?: boolean;
 
     /**
      * Customize the required parameters needed to import this resource. By default, the `requiredParameters` are taken
@@ -133,7 +140,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      *
      * See {@link importAndDestroy} for more information on how importing works.
      */
-    defaultRefreshValues?: Partial<T>
+    defaultRefreshValues?: Partial<T>;
   }
 }