@codifycli/plugin-core 1.0.0-beta6 → 1.0.1

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

@@ -1,4 +1,4 @@
-import { ZodObject, z } from 'zod';
+import { z, ZodObject } from 'zod';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import { resolveElementEqualsFn, resolveEqualsFn, resolveMatcher, resolveParameterTransformFn } from './resource-settings.js';
 export class ParsedResourceSettings {
@@ -23,8 +23,11 @@ export class ParsedResourceSettings {
                 ? z.toJSONSchema(schema.strict(), {
                     target: 'draft-7',
                     override(ctx) {
-                        ctx.jsonSchema.title = settings.id;
-                        ctx.jsonSchema.description = settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+                        if (ctx.path.length === 0) {
+                            ctx.jsonSchema.title = settings.id;
+                            ctx.jsonSchema.description = schema.description ?? settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+                            ctx.jsonSchema.$comment = schema.meta().$comment;
+                        }
                     }
                 })
                 : schema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.0.0-beta6",
+  "version": "1.0.1",
   "description": "TypeScript library for building Codify plugins to manage system resources (applications, CLI tools, settings) through infrastructure-as-code",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -51,8 +51,7 @@
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
     "@types/lodash.isequal": "^4.5.8",
-    "@types/node": "^20",
-    "@types/npmcli__promise-spawn": "^6.0.3",
+    "@types/node": "^22",
     "@types/semver": "^7.5.4",
     "@types/sinon": "^17.0.3",
     "@types/uuid": "^10.0.0",

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

@@ -165,9 +165,18 @@ describe('Resource options parser tests', () => {
   it('Can handle a zod schema', () => {
 
     const schema = z.object({
-      propA: z.string(),
-      repository: z.string(),
-    })
+      plugins: z
+        .array(z.string())
+        .describe(
+          'Asdf plugins to install. See: https://github.com/asdf-community for a full list'
+        )
+        .optional(),
+      repository: z
+        .string()
+        .describe('Remote repository to clone repo from. Equivalent to remote and only one should be specified')
+        .optional(),
+    }).meta({ $comment: 'https://codifycli.com/docs/resources/asdf/asdf' })
+      .describe('This is my test resource');
 
     const option: ResourceSettings<z.infer<typeof schema>> = {
       id: 'typeId',
@@ -180,7 +189,29 @@ describe('Resource options parser tests', () => {
       }
     }
 
-    console.log(new ParsedResourceSettings(option))
+    expect((new ParsedResourceSettings(option)).schema).toMatchObject({
+      '$schema': 'http://json-schema.org/draft-07/schema#',
+      type: 'object',
+      properties: {
+        plugins: {
+          description: 'Asdf plugins to install. See: https://github.com/asdf-community for a full list',
+          type: 'array',
+          items: {
+            "type": "string",
+          },
+        },
+        repository: {
+          description: 'Remote repository to clone repo from. Equivalent to remote and only one should be specified',
+          type: 'string'
+        }
+      },
+      additionalProperties: false,
+      title: 'typeId',
+      description: 'This is my test resource',
+      '$comment': 'https://codifycli.com/docs/resources/asdf/asdf'
+    })
+
+    console.log((new ParsedResourceSettings(option)).schema)
 
   })
 })

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

@@ -1,6 +1,6 @@
 import { LinuxDistro, OS, StringIndexedObject } from '@codifycli/schemas';
 import { JSONSchemaType } from 'ajv';
-import { ZodObject, z } from 'zod';
+import { z, ZodObject } from 'zod';
 
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import {
@@ -8,12 +8,12 @@ import {
   DefaultParameterSetting,
   InputTransformation,
   ParameterSetting,
-  ResourceSettings,
-  StatefulParameterSetting,
   resolveElementEqualsFn,
   resolveEqualsFn,
   resolveMatcher,
-  resolveParameterTransformFn
+  resolveParameterTransformFn,
+  ResourceSettings,
+  StatefulParameterSetting
 } from './resource-settings.js';
 
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
@@ -69,8 +69,11 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
         ? z.toJSONSchema(schema.strict(), {
           target: 'draft-7',
           override(ctx) {
-            ctx.jsonSchema.title = settings.id;
-            ctx.jsonSchema.description = settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+            if (ctx.path.length === 0) {
+              ctx.jsonSchema.title = settings.id;
+              ctx.jsonSchema.description = schema.description ?? settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
+              ctx.jsonSchema.$comment = (schema.meta() as Record<string, string | undefined>).$comment;
+            }
           }
         }) as JSONSchemaType<T>
         : schema;