codify-plugin-lib 1.0.94 → 1.0.95

package/dist/plugin/plugin.js

@@ -34,16 +34,16 @@ export class Plugin {
         const resource = this.resourceControllers.get(data.type);
         const schema = resource.settings.schema;
         const requiredPropertyNames = (resource.settings.import?.requiredParameters
-            ?? schema.required
+            ?? schema?.required
             ?? null);
         return {
             plugin: this.name,
             type: data.type,
             dependencies: resource.dependencies,
             schema: schema,
-            import: resource.settings.import ? {
+            import: {
                 requiredParameters: requiredPropertyNames,
-            } : undefined,
+            },
         };
     }
     async import(data) {

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

@@ -94,6 +94,27 @@ export class ParsedResourceSettings {
             && Object.values(this.parameterSettings).some((v) => v.type === 'stateful')) {
             throw new Error(`Resource: ${this.id}. Stateful parameters are not allowed if multiples of a resource exist`);
         }
+        const schema = this.settings.schema;
+        if (!this.settings.import && (schema?.oneOf
+            && Array.isArray(schema.oneOf)
+            && schema.oneOf.some((s) => s.required))
+            || (schema?.anyOf
+                && Array.isArray(schema.anyOf)
+                && schema.anyOf.some((s) => s.required))
+            || (schema?.allOf
+                && Array.isArray(schema.allOf)
+                && schema.allOf.some((s) => s.required))
+            || (schema?.then
+                && Array.isArray(schema.then)
+                && schema.then.some((s) => s.required))
+            || (schema?.else
+                && Array.isArray(schema.else)
+                && schema.else.some((s) => s.required))) {
+            throw new Error(`In the schema of ${this.settings.id}, a conditional required was declared (within anyOf, allOf, oneOf, else, or then) but an` +
+                'import.requiredParameters was not found in the resource settings. This is required because Codify uses the required parameter to' +
+                'determine the prompt to ask users during imports. It can\'t parse which parameters are needed when' +
+                'required is declared conditionally.');
+        }
     }
     validateParameterEqualsFn(parameter, key) {
         if (parameter.type === 'stateful') {

package/package.json

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

package/src/plugin/plugin.test.ts

@@ -101,4 +101,81 @@ describe('Plugin tests', () => {
     await testPlugin.apply({ plan })
     expect(resource.modify.calledOnce).to.be.true;
   });
+
+  it('Can get resource info', async () => {
+    const schema = {
+      "$schema": "http://json-schema.org/draft-07/schema",
+      "$id": "https://www.codifycli.com/asdf-schema.json",
+      "title": "Asdf resource",
+      "type": "object",
+      "properties": {
+        "plugins": {
+          "type": "array",
+          "description": "Asdf plugins to install. See: https://github.com/asdf-community for a full list",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["plugins"],
+      "additionalProperties": false
+    }
+
+
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'typeId',
+          schema,
+        }
+      }
+    }
+    const testPlugin = Plugin.create('testPlugin', [resource as any])
+
+    const resourceInfo = await testPlugin.getResourceInfo({ type: 'typeId' })
+    expect(resourceInfo.import).toMatchObject({
+      requiredParameters: [
+        'plugins'
+      ]
+    })
+  })
+
+  it('Get resource info to default import to the one specified in the resource settings', async () => {
+    const schema = {
+      "$schema": "http://json-schema.org/draft-07/schema",
+      "$id": "https://www.codifycli.com/asdf-schema.json",
+      "title": "Asdf resource",
+      "type": "object",
+      "properties": {
+        "plugins": {
+          "type": "array",
+          "description": "Asdf plugins to install. See: https://github.com/asdf-community for a full list",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["plugins"],
+      "additionalProperties": false
+    }
+
+
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'typeId',
+          schema,
+          import: {
+            requiredParameters: []
+          }
+        }
+      }
+    }
+    const testPlugin = Plugin.create('testPlugin', [resource as any])
+
+    const resourceInfo = await testPlugin.getResourceInfo({ type: 'typeId' })
+    expect(resourceInfo.import).toMatchObject({
+      requiredParameters: []
+    })
+  })
 });

package/src/plugin/plugin.ts

@@ -59,10 +59,10 @@ export class Plugin {
 
     const resource = this.resourceControllers.get(data.type)!;
 
-    const schema = resource.settings.schema as JSONSchemaType<any>;
+    const schema = resource.settings.schema as JSONSchemaType<any> | undefined;
     const requiredPropertyNames = (
       resource.settings.import?.requiredParameters
-        ?? schema.required 
+        ?? schema?.required
         ?? null
     ) as null | string[];
 
@@ -71,9 +71,9 @@ export class Plugin {
       type: data.type,
       dependencies: resource.dependencies,
       schema: schema as Record<string, unknown> | undefined,
-      import: resource.settings.import ? {
+      import: {
         requiredParameters: requiredPropertyNames,
-      } : undefined,
+      },
     }
   }
 

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

@@ -2,6 +2,7 @@ import { describe, expect, it } from 'vitest';
 import { ResourceSettings } from './resource-settings.js';
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { TestConfig } from '../utils/test-utils.test.js';
+import { JSONSchemaType } from 'ajv';
 
 describe('Resource options parser tests', () => {
   it('Parses default values from options', () => {
@@ -21,4 +22,48 @@ describe('Resource options parser tests', () => {
       propB: 'propB'
     })
   })
+
+  it('Throws an error when an import.requiredParameters is not declared', () => {
+    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"
+        },
+        "repository": {
+          "type": "string",
+          "description": "Remote repository to clone repo from. Equivalent to remote and only one should be specified"
+        },
+        "parentDirectory": {
+          "type": "string",
+          "description": "Parent directory to clone into. The folder name will use default git semantics which extracts the last part of the clone url. Only one of parentDirectory or directory can be specified"
+        },
+        "directory": {
+          "type": "string",
+          "description": "Directory to clone contents into. This value is directly passed into git clone. This differs from parent directory in that the last part of the path will be the folder name of the repo"
+        },
+        "autoVerifySSH": {
+          "type": "boolean",
+          "description": "Automatically verifies the ssh connection for ssh git clones. Defaults to true."
+        }
+      },
+      "additionalProperties": false,
+      "oneOf": [
+        { "required": ["repository", "directory"] },
+        { "required": ["repository", "parentDirectory"] },
+        { "required": ["remote", "directory"] }
+      ]
+    }
+
+    const option: ResourceSettings<TestConfig> = {
+      id: 'typeId',
+      schema,
+    }
+
+    expect(() => new ParsedResourceSettings(option)).throws;
+  })
 })

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

@@ -2,6 +2,7 @@ import { StringIndexedObject } from 'codify-schemas';
 
 import { ParameterSetting, resolveEqualsFn, ResourceSettings, StatefulParameterSetting } from './resource-settings.js';
 import { StatefulParameter as StatefulParameterImpl } from './stateful-parameter.js'
+import { JSONSchemaType } from 'ajv';
 
 export class ParsedResourceSettings<T extends StringIndexedObject> implements ResourceSettings<T> {
   private cache = new Map<string, unknown>();
@@ -130,6 +131,36 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
       && Object.values(this.parameterSettings).some((v) => v.type === 'stateful')) {
       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)
+        && schema.oneOf.some((s) => s.required)
+      )
+      || (schema?.anyOf
+        && Array.isArray(schema.anyOf)
+        && schema.anyOf.some((s) => s.required)
+      )
+      || (schema?.allOf
+        && Array.isArray(schema.allOf)
+        && schema.allOf.some((s) => s.required)
+      )
+      || (schema?.then
+        && Array.isArray(schema.then)
+        && schema.then.some((s) => s.required)
+      )
+      || (schema?.else
+        && Array.isArray(schema.else)
+        && schema.else.some((s) => s.required)
+      )
+    ) {
+      throw new Error(`In the schema of ${this.settings.id}, a conditional required was declared (within anyOf, allOf, oneOf, else, or then) but an` +
+        'import.requiredParameters was not found in the resource settings. This is required because Codify uses the required parameter to' +
+        'determine the prompt to ask users during imports. It can\'t parse which parameters are needed when' +
+        'required is declared conditionally.'
+      )
+    }
   }
 
   private validateParameterEqualsFn(parameter: ParameterSetting, key: string): void {