feat(Plugins): Add schema function for obtaining schema of plugins; f…

…ix typings

node/src/config.ts

@@ -2,16 +2,26 @@
 
 import { JSONSchema7 } from 'json-schema'
 import { fromJSON, toJSON } from './prelude'
+import { PluginInstallation } from './plugins'
 
 const addon = require('../index.node')
 
+// Warning: The following types are hand written and may become out of sync
+// with the actual JSON data returned by the functions below.
+// Use the `schema()` function as the authoritative source of the shape of
+// the config object.
+
 type LoggingLevel = 'debug' | 'info' | 'warn' | 'error' | 'never'
 
+type LoggingFormat = 'plain' | 'pretty' | 'json'
 export interface Config {
   logging: {
     stderr: {
       level: LoggingLevel
-      format: 'plain' | 'pretty' | 'json'
+      format: LoggingFormat
+    }
+    desktop: {
+      level: LoggingLevel
     }
     file: {
       path: string
@@ -24,10 +34,11 @@ export interface Config {
     insecure: boolean
   }
   plugins: {
-    kinds: Array<'docker' | 'binary' | 'package'>
+    installations: Array<PluginInstallation>
     aliases: Record<string, string>
   }
   upgrade: {
+    plugins: boolean
     confirm: boolean
     verbose: boolean
     auto: string

node/src/lib.rs

@@ -8,6 +8,7 @@ mod subscriptions;
 
 #[neon::main]
 fn main(mut cx: ModuleContext) -> NeonResult<()> {
+    cx.export_function("pluginsSchema", plugins::schema)?;
     cx.export_function("pluginsList", plugins::list)?;
     cx.export_function("pluginsInstall", plugins::install)?;
     cx.export_function("pluginsUninstall", plugins::uninstall)?;

node/src/logging.ts

@@ -2,10 +2,10 @@
 
 const addon = require('../index.node')
 
-export function init(): Plugin[] {
+export function init(): void {
   return addon.loggingInit()
 }
 
-export function test(): Plugin[] {
+export function test(): void {
   return addon.loggingTest()
 }

node/src/plugins.rs

@@ -32,6 +32,12 @@ pub fn obtain(cx: &mut FunctionContext) -> NeonResult<MutexGuard<'static, Plugin
     }
 }
 
+/// Get plugin schema
+pub fn schema(mut cx: FunctionContext) -> JsResult<JsString> {
+    let schema = plugins::schema();
+    Ok(cx.string(schema))
+}
+
 /// List plugins
 pub fn list(mut cx: FunctionContext) -> JsResult<JsString> {
     let aliases = &config::obtain(&mut cx)?.plugins.aliases;

node/src/plugins.test.ts

@@ -1,6 +1,19 @@
-import { list, install, uninstall, upgrade } from './plugins'
+import { install, list, schema, uninstall, upgrade } from './plugins'
 
 describe('plugins', () => {
+  test('schema', () => {
+    expect(schema()).toEqual(
+      expect.objectContaining({
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        title: 'Plugin',
+        type: 'object',
+        properties: expect.objectContaining({
+          name: { description: 'The name of the plugin', type: 'string' },
+        }),
+      })
+    )
+  })
+
   test('list', () => {
     expect(list()).toEqual(expect.arrayContaining([]))
   })

node/src/plugins.ts

@@ -1,10 +1,22 @@
 // Node.js bindings for ../../rust/src/plugins.rs, see there for more documentation.
 
+import { JSONSchema7 } from 'json-schema'
 import { fromJSON } from './prelude'
 
 const addon = require('../index.node')
 
-export type Installation = 'docker' | 'binary' | 'js' | 'py' | 'r' | 'link'
+// Warning: The following types are hand written and may become out of sync
+// with the actual JSON data returned by the functions below.
+// Use the `schema()` function as the authoritative source of the shape of
+// the plugin objects.
+
+export type PluginInstallation =
+  | 'docker'
+  | 'binary'
+  | 'javascript'
+  | 'python'
+  | 'r'
+  | 'link'
 
 export interface Plugin {
   // Properties from the plugin's manifest file
@@ -17,12 +29,22 @@ export interface Plugin {
 
   // Properties that are derived / updated
 
-  installation?: Installation
+  installation?: PluginInstallation
   refreshed?: string
   next?: Plugin
   alias?: string
 }
 
+/**
+ * Get the JSON schema for a plugin object
+ *
+ * @returns A JSON Schema v7 object describing the properties of
+ *          a plugin object
+ */
+export function schema(): JSONSchema7 {
+  return fromJSON<JSONSchema7>(addon.pluginsSchema())
+}
+
 /**
  * List plugins in registry and/or installed
  *
@@ -44,7 +66,7 @@ export function list(): Plugin[] {
  */
 export function install(
   spec: string,
-  installations?: Installation | Installation[]
+  installations?: PluginInstallation | PluginInstallation[]
 ): Plugin[] {
   return fromJSON<Plugin[]>(addon.pluginsInstall(spec, installations ?? []))
 }

rust/Cargo.toml

@@ -99,7 +99,7 @@ once_cell = "1.7.2"
 rand = "0.8.3"
 regex = "1.4.5"
 reqwest = { version = "0.11.3", optional = true, features = ["json"] }
-schemars = "0.8.3"
+schemars = { version = "0.8.3", features = ["preserve_order", "chrono"] }
 self_update = { version = "0.26.0", optional = true, features = [
     "archive-tar",
     "archive-zip",

rust/src/plugins.rs

@@ -8,7 +8,7 @@ use jsonschema::JSONSchema;
 use once_cell::sync::Lazy;
 use rand::Rng;
 use regex::Regex;
-use schemars::JsonSchema;
+use schemars::{schema_for, JsonSchema};
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use std::{
@@ -49,7 +49,7 @@ pub enum PluginInstallation {
 ///
 /// Property names use the Rust convention of snake_case but are renamed
 /// to schema.org camelCase on serialization.
-#[derive(Debug, Default, Clone, Deserialize, Serialize)]
+#[derive(Debug, Default, Clone, JsonSchema, Deserialize, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Plugin {
     // Properties that are read from the plugin's manifest file
@@ -92,6 +92,12 @@ pub struct Plugin {
     alias: Option<String>,
 }
 
+/// Get the JSON Schema for a plugin
+pub fn schema() -> String {
+    let schema = schema_for!(Plugin);
+    serde_json::to_string_pretty(&schema).unwrap()
+}
+
 impl Plugin {
     /// The name of the plugin file within the plugin directory
     const FILE_NAME: &'static str = "codemeta.json";
@@ -1571,18 +1577,26 @@ pub mod cli {
             setting = structopt::clap::AppSettings::ColoredHelp
         )]
         List,
+
         Show(Show),
-        #[structopt(
-            about = "List registered plugin aliases",
-            setting = structopt::clap::AppSettings::ColoredHelp
-        )]
-        Aliases,
         Install(Install),
         Link(Link),
         Upgrade(Upgrade),
         Uninstall(Uninstall),
         Unlink(Unlink),
         Refresh(Refresh),
+
+        #[structopt(
+            about = "List registered plugin aliases",
+            setting = structopt::clap::AppSettings::ColoredHelp
+        )]
+        Aliases,
+
+        #[structopt(
+            about = "Get the JSON Schema for plugins",
+            setting = structopt::clap::AppSettings::ColoredHelp
+        )]
+        Schema,
     }
 
     #[derive(Debug, StructOpt)]
@@ -1799,11 +1813,6 @@ pub mod cli {
                 }
                 Ok(())
             }
-            Action::Aliases => {
-                let md = plugins.display_aliases(aliases)?;
-                println!("{}", skin.term_text(md.as_str()));
-                Ok(())
-            }
             Action::Install(action) => {
                 let Install {
                     docker,
@@ -1868,6 +1877,15 @@ pub mod cli {
 
                 Plugin::refresh_list(list, aliases, plugins).await
             }
+            Action::Aliases => {
+                let md = plugins.display_aliases(aliases)?;
+                println!("{}", skin.term_text(md.as_str()));
+                Ok(())
+            }
+            Action::Schema => {
+                println!("{}", schema());
+                Ok(())
+            }
         }
     }
 }