codify-plugin-lib 1.0.92 → 1.0.94

package/dist/plugin/plugin.js

@@ -32,11 +32,18 @@ export class Plugin {
             throw new Error(`Cannot get info for resource ${data.type}, resource doesn't exist`);
         }
         const resource = this.resourceControllers.get(data.type);
+        const schema = resource.settings.schema;
+        const requiredPropertyNames = (resource.settings.import?.requiredParameters
+            ?? schema.required
+            ?? null);
         return {
             plugin: this.name,
             type: data.type,
             dependencies: resource.dependencies,
-            schema: resource.settings.schema
+            schema: schema,
+            import: resource.settings.import ? {
+                requiredParameters: requiredPropertyNames,
+            } : undefined,
         };
     }
     async import(data) {

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

@@ -52,6 +52,9 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * @param desired
      */
     inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+    import?: {
+        requiredParameters: Array<Partial<keyof T>>;
+    };
 }
 /**
  * The type of parameter. This value is mainly used to determine a pre-set equality method for comparing the current

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.92",
+  "version": "1.0.94",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.51",
+    "codify-schemas": "1.0.52",
     "@npmcli/promise-spawn": "^7.0.1",
     "uuid": "^10.0.0"
   },

package/src/messages/handlers.ts

@@ -4,7 +4,9 @@ import {
   ApplyRequestDataSchema,
   ApplyResponseDataSchema,
   GetResourceInfoRequestDataSchema,
-  GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema,
+  GetResourceInfoResponseDataSchema,
+  ImportRequestDataSchema,
+  ImportResponseDataSchema,
   InitializeRequestDataSchema,
   InitializeResponseDataSchema,
   IpcMessage,

package/src/plugin/plugin.ts

@@ -1,3 +1,4 @@
+import { JSONSchemaType } from 'ajv';
 import {
   ApplyRequestData,
   GetResourceInfoRequestData,
@@ -58,11 +59,21 @@ export class Plugin {
 
     const resource = this.resourceControllers.get(data.type)!;
 
+    const schema = resource.settings.schema as JSONSchemaType<any>;
+    const requiredPropertyNames = (
+      resource.settings.import?.requiredParameters
+        ?? schema.required 
+        ?? null
+    ) as null | string[];
+
     return {
       plugin: this.name,
       type: data.type,
       dependencies: resource.dependencies,
-      schema: resource.settings.schema as Record<string, unknown> | undefined
+      schema: schema as Record<string, unknown> | undefined,
+      import: resource.settings.import ? {
+        requiredParameters: requiredPropertyNames,
+      } : undefined,
     }
   }
 

package/src/resource/resource-controller.ts

@@ -214,7 +214,7 @@ export class ResourceController<T extends StringIndexedObject> {
       || currentParametersArray.filter(Boolean).length === 0
     ) {
       return currentParametersArray
-        ?.map((r) => ({ ...coreParameters, ...r }))
+          ?.map((r) => ({ ...coreParameters, ...r }))
         ?? null;
     }
 

package/src/resource/resource-settings.test.ts

@@ -524,4 +524,20 @@ describe('Resource parameter tests', () => {
     expect(plan.currentConfig?.propB).to.eq(10);
     expect(plan.currentConfig?.propC).to.be.undefined;
   })
+
+  it('Allows import required parameters customization', () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          import: {
+            requiredParameters: [
+              'propA',
+              'propB',
+            ]
+          }
+        }
+      }
+    };
+  })
 })

package/src/resource/resource-settings.ts

@@ -64,6 +64,10 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    * @param desired
    */
   inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+
+  import?: {
+    requiredParameters: Array<Partial<keyof T>>;
+  }
 }
 
 /**