codify-plugin-lib 1.0.96 → 1.0.98

package/dist/resource/parsed-resource-settings.js

@@ -115,6 +115,11 @@ export class ParsedResourceSettings {
                 'determine the prompt to ask users during imports. It can\'t parse which parameters are needed when ' +
                 'required is declared conditionally.');
         }
+        const importRequiredParameterNotInSchema = this.settings.import?.requiredParameters?.filter((p) => !(schema?.properties[p]));
+        if (schema && importRequiredParameterNotInSchema && importRequiredParameterNotInSchema.length > 0) {
+            throw new Error(`The following properties were declared in settings.import.requiredParameters but were not found in the schema:
+${JSON.stringify(importRequiredParameterNotInSchema, null, 2)}`);
+        }
     }
     validateParameterEqualsFn(parameter, key) {
         if (parameter.type === 'stateful') {

package/dist/resource/resource-controller.js

@@ -133,11 +133,16 @@ export class ResourceController {
     async import(config) {
         this.addDefaultValues(config);
         await this.applyTransformParameters(config);
-        // Try to refresh as many parameters as possible here
-        const parametersToRefresh = {
-            ...Object.fromEntries(this.getAllParameterKeys().map((k) => [k, null])),
-            ...config,
-        };
+        // Use refresh parameters if specified, otherwise try to refresh as many parameters as possible here
+        const parametersToRefresh = this.settings.import?.refreshParameters
+            ? {
+                ...Object.fromEntries(this.settings.import?.refreshParameters.map((k) => [k, null])),
+                ...config,
+            }
+            : {
+                ...Object.fromEntries(this.getAllParameterKeys().map((k) => [k, null])),
+                ...config,
+            };
         // Parse data from the user supplied config
         const parsedConfig = new ConfigParser(parametersToRefresh, null, this.parsedSettings.statefulParameters);
         const { allNonStatefulParameters, allStatefulParameters, coreParameters, } = parsedConfig;

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

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

package/package.json

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

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

@@ -65,4 +65,30 @@ describe('Resource options parser tests', () => {
 
     expect(() => new ParsedResourceSettings(option)).throws;
   })
+
+  it('Throws an error when an import.requiredParameters is declared improperly', () => {
+    const schema = {
+      '$schema': 'http://json-schema.org/draft-07/schema',
+      '$id': 'https://www.codifycli.com/git-clone.json',
+      'title': 'Git-clone resource',
+      'type': 'object',
+      'properties': {
+        'remote': {
+          'type': 'string',
+          'description': 'Remote tracking url to clone repo from. Equivalent to repository and only one should be specified'
+        },
+      },
+      'additionalProperties': false,
+    }
+
+    const option: ResourceSettings<TestConfig> = {
+      id: 'typeId',
+      schema,
+      import: {
+        requiredParameters: ['import-error']
+      }
+    }
+
+    expect(() => new ParsedResourceSettings(option)).throws;
+  })
 })

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

@@ -3,10 +3,10 @@ import { StringIndexedObject } from 'codify-schemas';
 
 import {
   ParameterSetting,
-  ResourceSettings,
-  StatefulParameterSetting,
   resolveEqualsFn,
-  resolveParameterTransformFn
+  resolveParameterTransformFn,
+  ResourceSettings,
+  StatefulParameterSetting
 } from './resource-settings.js';
 import { StatefulParameter as StatefulParameterImpl } from './stateful-parameter.js'
 
@@ -138,7 +138,6 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
       throw new Error(`Resource: ${this.id}. Stateful parameters are not allowed if multiples of a resource exist`)
     }
 
-
     const schema = this.settings.schema as JSONSchemaType<any>;
     if (!this.settings.import && (schema?.oneOf
         && Array.isArray(schema.oneOf)
@@ -167,6 +166,13 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
         'required is declared conditionally.'
       )
     }
+
+    const importRequiredParameterNotInSchema =
+      this.settings.import?.requiredParameters?.filter((p) => !(schema?.properties[p]))
+    if (schema && importRequiredParameterNotInSchema && importRequiredParameterNotInSchema.length > 0) {
+      throw new Error(`The following properties were declared in settings.import.requiredParameters but were not found in the schema:
+${JSON.stringify(importRequiredParameterNotInSchema, null, 2)}`)
+    }
   }
 
   private validateParameterEqualsFn(parameter: ParameterSetting, key: string): void {

package/src/resource/resource-controller.ts

@@ -189,8 +189,15 @@ export class ResourceController<T extends StringIndexedObject> {
     this.addDefaultValues(config);
     await this.applyTransformParameters(config);
 
-    // Try to refresh as many parameters as possible here
-    const parametersToRefresh = {
+    // Use refresh parameters if specified, otherwise try to refresh as many parameters as possible here
+    const parametersToRefresh = this.settings.import?.refreshParameters
+      ? {
+        ...Object.fromEntries(
+          this.settings.import?.refreshParameters.map((k) => [k, null])
+        ),
+        ...config,
+      }
+      : {
       ...Object.fromEntries(
         this.getAllParameterKeys().map((k) => [k, null])
       ),

package/src/resource/resource-settings.ts

@@ -66,7 +66,9 @@ export interface ResourceSettings<T extends StringIndexedObject> {
   inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
 
   import?: {
-    requiredParameters: Array<Partial<keyof T>>;
+    requiredParameters?: Array<Partial<keyof T>>;
+
+    refreshParameters?: Array<Partial<keyof T>>;
   }
 }