codify-plugin-lib 1.0.182-beta52 → 1.0.182-beta54

package/bin/build.js

@@ -5,9 +5,8 @@ import mergeJsonSchemas from 'merge-json-schemas';
 import { fork } from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
-import * as url from 'node:url';
 
-import { VerbosityLevel, SequentialPty } from '../dist/index.js';
+import { SequentialPty, VerbosityLevel } from '../dist/index.js';
 
 const ajv = new Ajv({
   strict: true
@@ -36,6 +35,58 @@ function sendMessageAndAwaitResponse(process, message) {
   });
 }
 
+function fetchDocumentationMaps() {
+  console.log('Building documentation...');
+
+  const results = new Map();
+  const resourcesPath = path.resolve(process.cwd(), 'src', 'resources');
+  const resourcesDir = fs.readdirSync(resourcesPath);
+
+  for (const resource of resourcesDir) {
+    const resourcePath = path.join(resourcesPath, resource);
+    if (!isDirectory(resourcePath)) continue;
+
+    const contents = fs.readdirSync(resourcePath);
+    const isGroup = contents.some((content) => isDirectory(path.join(resourcePath, content)));
+    const isAllDir = contents.every((content) => isDirectory(path.join(resourcePath, content)));
+
+    if (isGroup && !isAllDir) {
+      throw new Error(`Documentation groups must only contain directories. ${resourcePath} does not`);
+    }
+
+    if (!isGroup) {
+      if (contents.includes('README.md')) {
+        results.set(resource, resource);
+      }
+    } else {
+      for (const innerDir of contents) {
+        const innerDirReadme = path.join(resourcePath, innerDir, 'README.md');
+        if (isFile(innerDirReadme)) {
+          results.set(innerDir, path.relative('./src/resources', path.join(resourcePath, innerDir)));
+        }
+      }
+    }
+  }
+
+  return results;
+}
+
+function isDirectory(path) {
+  try {
+    return fs.statSync(path).isDirectory();
+  } catch {
+    return false;
+  }
+}
+
+function isFile(path) {
+  try {
+    return fs.statSync(path).isFile();
+  } catch {
+    return false;
+  }
+}
+
 VerbosityLevel.set(3);
 const $ = new SequentialPty();
 
@@ -60,6 +111,7 @@ const initializeResult = await sendMessageAndAwaitResponse(plugin, {
 
 const { resourceDefinitions } = initializeResult;
 const resourceTypes = resourceDefinitions.map((i) => i.type);
+const resourceInfoMap = new Map();
 
 const schemasMap = new Map()
 for (const type of resourceTypes) {
@@ -69,8 +121,11 @@ for (const type of resourceTypes) {
   })
 
   schemasMap.set(type, resourceInfo.schema);
+  resourceInfoMap.set(type, resourceInfo);
 }
 
+console.log(resourceInfoMap);
+
 const mergedSchemas = [...schemasMap.entries()].map(([type, schema]) => {
   // const resolvedSchema = await $RefParser.dereference(schema)
   const resourceSchema = JSON.parse(JSON.stringify(ResourceSchema));
@@ -97,12 +152,38 @@ await $.spawn('npm run rollup', { interactive: true }); // re-run rollup without
 
 console.log('Generated JSON Schemas for all resources')
 
-const distFolder = path.resolve(path.dirname(url.fileURLToPath(import.meta.url)), '..', 'dist');
+const distFolder = path.resolve(process.cwd(), 'dist');
 const schemaOutputPath = path.resolve(distFolder, 'schemas.json');
 fs.writeFileSync(schemaOutputPath, JSON.stringify(mergedSchemas, null, 2));
 
-console.log('Successfully wrote schema to ./dist/schemas.json')
-
+console.log('Successfully wrote schema to ./dist/schemas.json');
+
+const documentationMap = fetchDocumentationMaps();
+
+const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+
+fs.writeFileSync('./dist/manifest.json', JSON.stringify({
+  name: packageJson.name,
+  version: packageJson.version,
+  description: packageJson.description,
+  resources: [...resourceInfoMap.values()].map((info) => ({
+    type: info.type,
+    description: info.description ?? info.schema?.description,
+    sensitiveParameters: info.sensitiveParameters,
+    schema: info.schema,
+    operatingSystems: info.operatingSystems,
+    documentationKey: documentationMap.get(info.type),
+  })),
+}, null, 2), 'utf8');
+
+for (const key of documentationMap.values()) {
+  fs.mkdirSync(path.join('dist', 'documentation', key), { recursive: true })
+
+  fs.copyFileSync(
+    path.resolve(path.join('src', 'resources', key, 'README.md')),
+    path.resolve(path.join('dist', 'documentation', key, 'README.md')),
+  );
+}
 
 plugin.kill(9);
 process.exit(0);

package/dist/messages/handlers.js

@@ -1,6 +1,6 @@
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
-import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, IpcMessageV2Schema, MatchRequestDataSchema, MatchResponseDataSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
+import { ApplyRequestDataSchema, ApplyResponseDataSchema, EmptyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, IpcMessageV2Schema, MatchRequestDataSchema, MatchResponseDataSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, SetVerbosityRequestDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
@@ -18,6 +18,11 @@ const SupportedRequests = {
         requestValidator: GetResourceInfoRequestDataSchema,
         responseValidator: GetResourceInfoResponseDataSchema
     },
+    'setVerbosityLevel': {
+        handler: async (plugin, data) => plugin.setVerbosityLevel(data),
+        requestValidator: SetVerbosityRequestDataSchema,
+        responseValidator: EmptyResponseDataSchema
+    },
     'match': {
         handler: async (plugin, data) => plugin.match(data),
         requestValidator: MatchRequestDataSchema,

package/dist/plugin/plugin.d.ts

@@ -1,4 +1,4 @@
-import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeRequestData, InitializeResponseData, MatchRequestData, MatchResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ResourceJson, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
+import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeRequestData, InitializeResponseData, MatchRequestData, MatchResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ResourceJson, SetVerbosityRequestData, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from '../plan/plan.js';
 import { BackgroundPty } from '../pty/background-pty.js';
 import { Resource } from '../resource/resource.js';
@@ -17,6 +17,7 @@ export declare class Plugin {
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;
     plan(data: PlanRequestData): Promise<PlanResponseData>;
     apply(data: ApplyRequestData): Promise<void>;
+    setVerbosityLevel(data: SetVerbosityRequestData): Promise<void>;
     kill(): Promise<void>;
     private resolvePlan;
     protected crossValidateResources(resources: ResourceJson[]): Promise<void>;

package/dist/plugin/plugin.js

@@ -173,6 +173,9 @@ export class Plugin {
             throw new ApplyValidationError(plan);
         }
     }
+    async setVerbosityLevel(data) {
+        VerbosityLevel.set(data.verbosityLevel);
+    }
     async kill() {
         await this.planPty.kill();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.182-beta52",
+  "version": "1.0.182-beta54",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "clean-deep": "^3.4.0",
-    "codify-schemas": "1.0.86-beta7",
+    "codify-schemas": "1.0.86-beta9",
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
     "strip-ansi": "^7.1.0",

package/src/messages/handlers.ts

@@ -2,7 +2,7 @@ import { Ajv, SchemaObject, ValidateFunction } from 'ajv';
 import addFormats from 'ajv-formats';
 import {
   ApplyRequestDataSchema,
-  ApplyResponseDataSchema,
+  ApplyResponseDataSchema, EmptyResponseDataSchema,
   GetResourceInfoRequestDataSchema,
   GetResourceInfoResponseDataSchema,
   ImportRequestDataSchema,
@@ -19,6 +19,7 @@ import {
   PlanRequestDataSchema,
   PlanResponseDataSchema,
   ResourceSchema,
+  SetVerbosityRequestDataSchema,
   ValidateRequestDataSchema,
   ValidateResponseDataSchema
 } from 'codify-schemas';
@@ -42,6 +43,11 @@ const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) =
     requestValidator: GetResourceInfoRequestDataSchema,
     responseValidator: GetResourceInfoResponseDataSchema
   },
+  'setVerbosityLevel': {
+    handler: async (plugin: Plugin, data: any) => plugin.setVerbosityLevel(data),
+    requestValidator: SetVerbosityRequestDataSchema,
+    responseValidator: EmptyResponseDataSchema
+  },
   'match': {
     handler: async (plugin: Plugin, data: any) => plugin.match(data),
     requestValidator: MatchRequestDataSchema,

package/src/plugin/plugin.ts

@@ -12,7 +12,7 @@ import {
   PlanRequestData,
   PlanResponseData,
   ResourceConfig,
-  ResourceJson,
+  ResourceJson, SetVerbosityRequestData,
   ValidateRequestData,
   ValidateResponseData
 } from 'codify-schemas';
@@ -257,6 +257,10 @@ export class Plugin {
     }
   }
 
+  async setVerbosityLevel(data: SetVerbosityRequestData): Promise<void> {
+    VerbosityLevel.set(data.verbosityLevel);
+  }
+
   async kill() {
     await this.planPty.kill();
   }