codify-plugin-lib 1.0.97 → 1.0.99

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

@@ -115,10 +115,26 @@ 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)}`);
+        if (this.settings.import) {
+            const { requiredParameters, refreshKeys, defaultRefreshValues } = this.settings.import;
+            const requiredParametersNotInSchema = requiredParameters
+                ?.filter((p) => schema && !(schema.properties[p]));
+            if (schema && requiredParametersNotInSchema && requiredParametersNotInSchema.length > 0) {
+                throw new Error(`The following properties were declared in settings.import.requiredParameters but were not found in the schema:
+${JSON.stringify(requiredParametersNotInSchema, null, 2)}`);
+            }
+            const refreshKeyNotInSchema = refreshKeys
+                ?.filter((k) => schema && !(schema.properties[k]));
+            if (schema && refreshKeyNotInSchema && refreshKeyNotInSchema.length > 0) {
+                throw new Error(`The following properties were declared in settings.import.refreshKeys but were not found in the schema:
+${JSON.stringify(requiredParametersNotInSchema, null, 2)}`);
+            }
+            const refreshValueNotInRefreshKey = Object.entries(defaultRefreshValues ?? {})
+                .filter(([k]) => schema && !(schema.properties[k])).map(([k]) => k);
+            if (schema && refreshValueNotInRefreshKey.length > 0) {
+                throw new Error(`Properties declared in defaultRefreshValues must already be declared in refreshKeys:
+${JSON.stringify(refreshValueNotInRefreshKey, null, 2)}`);
+            }
         }
     }
     validateParameterEqualsFn(parameter, key) {

package/dist/resource/resource-controller.js

@@ -133,11 +133,18 @@ 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?.refreshKeys
+            ? {
+                ...Object.fromEntries(this.settings.import?.refreshKeys.map((k) => [k, null])),
+                ...this.settings.import?.defaultRefreshValues,
+                ...config,
+            }
+            : {
+                ...Object.fromEntries(this.getAllParameterKeys().map((k) => [k, null])),
+                ...this.settings.import?.defaultRefreshValues,
+                ...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,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>>;
+        refreshKeys?: Array<Partial<keyof T>>;
+        defaultRefreshValues?: Partial<T>;
     };
 }
 /**

package/package.json

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

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

@@ -63,19 +63,16 @@ describe('Resource options parser tests', () => {
       schema,
     }
 
-    expect(() => new ParsedResourceSettings(option)).throws;
+    expect(() => new ParsedResourceSettings(option)).toThrowError();
   })
 
   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,
@@ -89,6 +86,77 @@ describe('Resource options parser tests', () => {
       }
     }
 
-    expect(() => new ParsedResourceSettings(option)).throws;
+    expect(() => new ParsedResourceSettings(option)).toThrowError();
+  })
+
+  it('Throws an error when an import.refreshKeys is declared improperly', () => {
+    const schema = {
+      '$schema': 'http://json-schema.org/draft-07/schema',
+      'type': 'object',
+      'properties': {
+        'remote': {
+          'type': 'string',
+        },
+      },
+      'additionalProperties': false,
+    }
+
+    const option: ResourceSettings<TestConfig> = {
+      id: 'typeId',
+      schema,
+      import: {
+        refreshKeys: ['import-error']
+      }
+    }
+
+    expect(() => new ParsedResourceSettings(option)).toThrowError();
+  })
+
+  it('Doesn\'t throw an error when an import.refreshValues is declared properly', () => {
+    const schema = {
+      '$schema': 'http://json-schema.org/draft-07/schema',
+      'type': 'object',
+      'properties': {
+        'remote': {
+          'type': 'string',
+        },
+      },
+      'additionalProperties': false,
+    }
+
+    const option: ResourceSettings<TestConfig> = {
+      id: 'typeId',
+      schema,
+      import: {
+        refreshKeys: ['remote'],
+      }
+    }
+
+    expect(() => new ParsedResourceSettings(option)).not.toThrowError()
+  })
+
+  it('Throws an error if defaultRefreshValue is not found in refreshKeys', () => {
+    const schema = {
+      '$schema': 'http://json-schema.org/draft-07/schema',
+      'type': 'object',
+      'properties': {
+        'remote': {
+          'type': 'string',
+        },
+      },
+      'additionalProperties': false,
+    }
+
+    const option: ResourceSettings<TestConfig> = {
+      id: 'typeId',
+      schema,
+      import: {
+        defaultRefreshValues: {
+          repository: 'abc'
+        }
+      }
+    }
+
+    expect(() => new ParsedResourceSettings(option)).toThrowError()
   })
 })

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

@@ -167,11 +167,37 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
       )
     }
 
-    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)}`)
+    if (this.settings.import) {
+      const { requiredParameters, refreshKeys, defaultRefreshValues } = this.settings.import;
+
+      const requiredParametersNotInSchema = requiredParameters
+          ?.filter(
+            (p) => schema && !(schema.properties[p])
+          )
+      if (schema && requiredParametersNotInSchema && requiredParametersNotInSchema.length > 0) {
+        throw new Error(`The following properties were declared in settings.import.requiredParameters but were not found in the schema:
+${JSON.stringify(requiredParametersNotInSchema, null, 2)}`)
+      }
+
+      const refreshKeyNotInSchema = refreshKeys
+        ?.filter(
+          (k) => schema && !(schema.properties[k])
+        )
+      if (schema && refreshKeyNotInSchema && refreshKeyNotInSchema.length > 0) {
+        throw new Error(`The following properties were declared in settings.import.refreshKeys but were not found in the schema:
+${JSON.stringify(requiredParametersNotInSchema, null, 2)}`)
+      }
+
+      const refreshValueNotInRefreshKey =
+        Object.entries(defaultRefreshValues ?? {})
+          .filter(
+            ([k]) => schema && !(schema.properties[k])
+          ).map(([k]) => k)
+
+      if (schema && refreshValueNotInRefreshKey.length > 0) {
+        throw new Error(`Properties declared in defaultRefreshValues must already be declared in refreshKeys:
+${JSON.stringify(refreshValueNotInRefreshKey, null, 2)}`)
+      }
     }
   }
 

package/src/resource/resource-controller.ts

@@ -189,13 +189,22 @@ export class ResourceController<T extends StringIndexedObject> {
     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?.refreshKeys
+      ? {
+        ...Object.fromEntries(
+          this.settings.import?.refreshKeys.map((k) => [k, null])
+        ),
+        ...this.settings.import?.defaultRefreshValues,
+        ...config,
+      }
+      : {
+        ...Object.fromEntries(
+          this.getAllParameterKeys().map((k) => [k, null])
+        ),
+        ...this.settings.import?.defaultRefreshValues,
+        ...config,
+      };
 
     // Parse data from the user supplied config
     const parsedConfig = new ConfigParser(parametersToRefresh, null, this.parsedSettings.statefulParameters)

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

@@ -612,4 +612,21 @@ describe('Resource parameter tests', () => {
 
     expect(plan.changeSet.operation).to.eq(ResourceOperation.NOOP);
   })
+
+  it('Accepts an input parameters for imports', () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          import: {
+            requiredParameters: ['propA'],
+            refreshKeys: ['propB', 'propA'],
+            defaultRefreshValues: {
+              propB: 6,
+            }
+          }
+        }
+      }
+    };
+  })
 })

package/src/resource/resource-settings.ts

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