feat: Add support on db side for example and default parameters

Author: kevinwang5658

package-lock.json

@@ -42,7 +42,7 @@
   "license": "ISC",
   "type": "module",
   "dependencies": {
-    "@codifycli/plugin-core": "1.0.1",
+    "@codifycli/plugin-core": "1.1.0-beta5",
     "@codifycli/schemas": "1.0.0",
     "ajv": "^8.18.0",
     "ajv-formats": "^2.1.1",

package.json

@@ -37,6 +37,9 @@ if (!isBeta) {
 
 async function uploadResources() {
   const CodifySchema = require('../dist/schemas.json');
+  const Metadata: Array<Record<string, any>> = require('../dist/metadata.json');
+
+  const metadataByType = new Map(Metadata.map((m) => [m.type, m]));
 
   const client = createClient(
     process.env.SUPABASE_URL!,
@@ -55,6 +58,7 @@ async function uploadResources() {
 
   for (const resource of resources) {
     const type = resource.properties.type.const;
+    const metadata = metadataByType.get(type);
 
     console.log(`Adding resource ${type}`)
     const resourceRow = await client.from('registry_resources').upsert({
@@ -63,19 +67,28 @@ async function uploadResources() {
       plugin_name: pluginName,
       schema: JSON.stringify(resource),
       documentation_url: resource.$comment,
+      allow_multiple: metadata?.allowMultiple ?? false,
+      os: metadata?.operatingSystems ?? [],
+      default_config: metadata?.defaultConfig ? JSON.stringify(metadata.defaultConfig) : null,
+      example_config_1: metadata?.exampleConfigs?.example1 ? JSON.stringify(metadata.exampleConfigs.example1) : null,
+      example_config_2: metadata?.exampleConfigs?.example2 ? JSON.stringify(metadata.exampleConfigs.example2) : null,
     }, { onConflict: ['type', 'plugin_id'] })
       .select()
       .throwOnError();
 
     const { id: resourceId } = resourceRow.data![0];
 
+    const sensitiveParams: string[] = metadata?.sensitiveParameters ?? [];
+    const allSensitive = sensitiveParams.includes('*');
+
     const parameters = Object.entries(resource.properties)
       .filter(([k]) => k !== 'type')
       .map(([key, property]) => ({
-        type: property.type,
+        type: (property as any).type,
         name: key,
         resource_id: resourceId,
         schema: property,
+        is_sensitive: allSensitive || sensitiveParams.includes(key),
       }))
 
     await client.from('registry_resource_parameters')

scripts/deploy.ts

@@ -0,0 +1,46 @@
+import { ExampleConfigs } from '@codifycli/plugin-core';
+
+export const exampleSshConfigs: ExampleConfigs = {
+  example1: {
+    title: 'Example git ssh setup',
+    configs: [
+      {
+        "type": "ssh-key",
+        "passphrase": ""
+      },
+      {
+        "type": "ssh-config",
+        "hosts": [{
+          "Host": "github.com",
+          "AddKeysToAgent": true,
+          "UseKeychain": true,
+          "IdentityFile": "~/.ssh/id_ed25519",
+          "IgnoreUnknown": "UseKeychain"
+        }]
+      },
+      {
+        "type": "ssh-add",
+        "path": "~/.ssh/id_ed25519",
+        "appleUseKeychain": true,
+        "os": ["macOS"],
+        "dependsOn": ["ssh-config"]
+      },
+      {
+        "type": "ssh-add",
+        "path": "~/.ssh/id_ed25519",
+        "os": ["linux"],
+        "dependsOn": ["ssh-config"]
+      },
+      {
+        "type": 'wait-github-ssh-key',
+        "dependsOn": ["ssh-config"]
+      },
+      {
+        "type": 'git-repository',
+        "parentDirectory": '~/projects',
+        "repositories": ['<Replace me here!>', '<Replace me here!>']
+      }
+    ],
+    description: 'Configures GitHub SSH access for cloning, pulling, and pushing. Generates a new id_ed25519 key and provides step-by-step guidance for uploading it to GitHub.'
+  },
+}

src/resources/ssh/examples.ts

@@ -11,6 +11,8 @@ import path from 'node:path';
 import { FileUtils } from '../../utils/file-utils.js';
 import { SshConfigHostsParameter } from './ssh-config-hosts-parameter.js';
 import Schema from './ssh-config-schema.json';
+import { SshKeyConfig } from './ssh-key.js';
+import { exampleSshConfigs } from './examples.js';
 
 export type SshConfigOptions = Partial<{
   Host: string;
@@ -32,10 +34,22 @@ export interface SshConfig extends StringIndexedObject {
   hosts: Array<Partial<SshConfigOptions>>;
 }
 
+const defaultConfig: Partial<SshConfig> = {
+  hosts: [{
+    Host: "*",
+    AddKeysToAgent: true,
+    UseKeychain: true,
+    IdentityFile: "~/.ssh/id_ed25519",
+    IgnoreUnknown: "UseKeychain"
+  }]
+}
+
 export class SshConfigFileResource extends Resource<SshConfig> {
   getSettings(): ResourceSettings<SshConfig> {
     return {
       id: 'ssh-config',
+      defaultConfig,
+      exampleConfigs: exampleSshConfigs,
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       isSensitive: true,

src/resources/ssh/ssh-config.ts

@@ -14,6 +14,7 @@ import path from 'node:path';
 
 import { FileUtils } from '../../utils/file-utils.js';
 import Schema from './ssh-key-schema.json';
+import { exampleSshConfigs } from './examples.js';
 
 export type SshKeyType = 'ecdsa' | 'ecdsa-sk' | 'ed25519' | 'ed25519-sk' | 'rsa';
 
@@ -26,12 +27,19 @@ export interface SshKeyConfig extends StringIndexedObject {
   folder: string;
 }
 
+const defaultConfig: Partial<SshKeyConfig> = {
+  keyType: 'ed25519',
+  passphrase: '',
+}
+
 const SSH_KEYGEN_FINGERPRINT_REGEX = /^(\d+) (.*):(.*) (.*) \((.*)\)$/
 
 export class SshKeyResource extends Resource<SshKeyConfig> {
   getSettings(): ResourceSettings<SshKeyConfig> {
     return {
       id: 'ssh-key',
+      defaultConfig: defaultConfig,
+      exampleConfigs: exampleSshConfigs,
       operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       parameterSettings: {