Merge pull request #288 from neuroverse-fm/feat/standard-json-schema-spec

feat: standard json schema support

Author: KTrain5169

CHANGELOG.md

@@ -6,6 +6,15 @@ Since v2.1.0, we're keeping a changelog of each version's changes in NeuroPilot.
 
 Changes between each version before then will not be listed.
 
+## 3.0.0
+
+### Additions
+
+- Internally, NeuroPilot changed to use [Zod](https://zod.dev) for JSON schema generation and validation.
+  - This shouldn't mean that schemas are changed (except `rewrite_lines`, which is intentional). If any schemas have been changed as a result of this, it is considered a regression, and [is worth reporting](https://github.com/VSC-NeuroPilot/neuropilot/issues/new).
+  - NeuroPilot actually accepts any TypeScript schema library that conforms to the [Standard JSON Schema specification](https://standardschema.dev/json-schema), however this is only relevant for the public API where companion developers can choose between schema libraries listed as compatible in the above list.
+  - By default, NeuroPilot will attempt to convert these schemas to the `draft-07` JSON schema version. Failing that, it will try to convert to `draft-2020-12` instead, with a warning logged in console. NeuroPilot does *not* attempt conversion to `openapi-3.0`, as it uses keywords not in the official JSON schema specification.
+
 ## 2.5.0
 
 ### New settings

CONTRIBUTING.md

@@ -5,10 +5,12 @@ Please refer to our [contributor docs](https://vsc-neuropilot.github.io/docs/met
 ## Contributing
 
 If you have an idea or want to contribute a feature, please first [create an issue](https://github.com/VSC-NeuroPilot/neuropilot/issues) or send a message to `@Pasu4` in the project's [post on the Neuro Discord](https://discord.com/channels/574720535888396288/1350968830230396938).
-If you make a pull request that contributes code, please run `npm run lint src` and resolve any errors that did not get auto-fixed, preferrably before each commit.
+If you make a pull request that contributes code, please run `pnpm run lint src` and resolve any errors that did not get auto-fixed, preferrably before each commit.
 
 PRs should generally target the `dev` branch (or another feature branch) unless there is a specific reason to do otherwise (if so, please explain it in your PR).
 
+New actions should use [Zod](https://zod.dev) for schema generation, instead of plain JSON schema objects.
+
 This repository accepts only TypeScript for the main code. Submissions in JavaScript to the core code will require a conversion to TypeScript first.
 
 ## Views

esbuild-configs/web.esbuild.js

@@ -141,6 +141,7 @@ export async function webTestBrowser(_prodFlag, watchFlag) {
             polyfillNode({
                 polyfills: {
                     child_process: false,
+                    crypto: true,
                     module: false,
                     os: false,
                     path: false,

package.json

@@ -819,6 +819,8 @@
 		"build:web:esbuild": "node ./scripts/esbuild.mjs --mode web",
 		"build:desktop:tsc": "tsc --noEmit --project tsconfig.app.json",
 		"build:desktop:esbuild": "node ./scripts/esbuild.mjs --mode desktop",
+		"build:webview:tsc": "tsc --noEmit --project tsconfig.webview.json",
+		"build:webview:esbuild": "node ./scripts/esbuild.mjs --mode webview",
 		"watch:web": "npm-run-all -p watch:web:* watch:webview:*",
 		"watch:desktop": "npm-run-all -p watch:desktop:* watch:webview:*",
 		"watch:web:esbuild": "node ./scripts/esbuild.mjs --watch --mode web",
@@ -847,6 +849,7 @@
 	},
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
+		"@standard-schema/spec": "^1.1.0",
 		"@stylistic/eslint-plugin": "^5.10.0",
 		"@types/glob-to-regexp": "^0.4.4",
 		"@types/json-schema": "^7.0.15",
@@ -886,6 +889,7 @@
 		"ignore": "^7.0.5",
 		"jsonschema": "^1.5.0",
 		"neuro-game-sdk": "^1.1.1",
-		"preact": "^10.29.2"
+		"preact": "^10.29.2",
+		"zod": "^4.4.3"
 	}
 }

pnpm-lock.yaml

@@ -1,11 +1,11 @@
 import * as vscode from 'vscode';
+import { z } from 'zod';
 
 import { EXCEPTION_THROWN_STRING, NEURO } from '@/constants';
 import { getFence, logOutput } from '@/utils/misc';
-import { actionHandlerFailure, ActionHandlerResult, actionHandlerSuccess, RCEAction } from '@/utils/neuro_client';
+import { actionHandlerFailure, ActionHandlerResult, actionHandlerSuccess, defineAction } from '@/utils/neuro_client';
 import { CONNECTION, PermissionLevel } from '@/config';
 import { addActions, CATEGORY_MISC } from './rce';
-import { RCEContext } from '@ctx/rce';
 
 const MEMENTO_KEY = 'lastDeliveredChangelogVersion';
 
@@ -15,24 +15,22 @@ interface ChangelogSection {
 }
 
 export const changelogActions = {
-    read_changelog: {
+    read_changelog: defineAction({
         name: 'read_changelog',
         description: 'Get changelog entries starting from a specified version. If fromVersion is omitted, any new entries after the last read_changelog command are read.',
         category: CATEGORY_MISC,
-        schema: {
-            type: 'object',
-            properties: {
-                fromVersion: { type: 'string', description: 'Version (e.g., 2.2.1) to start including entries from, inclusive.' },
-            },
-            additionalProperties: false,
-        },
+        schema: z.object({
+            fromVersion: z.string().meta({
+                description: 'Version (e.g., 2.2.1) to start including entries from, inclusive.',
+            }),
+        }),
         defaultPermission: PermissionLevel.COPILOT,
-        handler: handleReadChangelog,
-        promptGenerator: (context: RCEContext) => context.data.params?.fromVersion
+        handler: (ctx) => handleReadChangelog(ctx.data.params.fromVersion),
+        promptGenerator: (context) => context.data.params.fromVersion
             ? `read all changelog entries starting from version ${context.data.params.fromVersion} (inclusive).`
             : 'read the latest changelog entries.',
-    },
-} satisfies Record<string, RCEAction>;
+    }),
+};
 
 export function addChangelogActions(): void {
     addActions([changelogActions.read_changelog]);
@@ -84,8 +82,8 @@ export async function sendChangelogOnDemand() {
     }
 }
 
-function handleReadChangelog(context: RCEContext): Thenable<ActionHandlerResult> {
-    return readAndStructureChangelog(context.data.params?.fromVersion);
+function handleReadChangelog(version: string): Thenable<ActionHandlerResult> {
+    return readAndStructureChangelog(version);
 }
 
 async function readAndParseChangelog(): Promise<{ sections: ChangelogSection[]; latest: string; }> {

src/changelog.ts

@@ -1,12 +1,11 @@
 import * as vscode from 'vscode';
+import assert from 'node:assert';
+import { z } from 'zod';
 
 import { NEURO } from '@/constants';
 import { filterFileContents, logOutput, simpleFileName } from '@/utils/misc';
 import { CONFIG, CONNECTION, PermissionLevel } from '@/config';
-import assert from 'node:assert';
-import { JSONSchema7 } from 'json-schema';
-import { actionHandlerFailure, actionHandlerSuccess, actionValidationAccept, actionValidationFailure, RCEAction, RCEHandlerReturns } from './utils/neuro_client';
-import { RCEContext } from './context/rce';
+import { actionHandlerFailure, actionHandlerSuccess, actionValidationAccept, actionValidationFailure, defineAction } from './utils/neuro_client';
 import { abortActionForce, addActions, registerAction, tryForceActions } from '@/rce';
 
 let requestCancelled = false;
@@ -49,35 +48,28 @@ export function addChatAction() {
     addActions([chatAction], false);
 }
 
-function handleChat(context: RCEContext): RCEHandlerReturns {
-    const answer = context.data.params!.answer;
-
-    if (requestCancelled) {
-        return actionHandlerFailure('Request was cancelled');
-    }
-
-    lastChatResponse = answer;
-    logOutput('INFO', 'Received chat response:\n' + answer);
-    return actionHandlerSuccess();
-}
-
-export const chatAction: RCEAction = {
+export const chatAction = defineAction({
     name: 'chat',
     description:
         `Provide an answer to ${CONNECTION.userName}'s request.` +
         ' Use markdown to format your response.' +
         ' You may additionally include code blocks by using triple backticks.' +
         ' Be sure to use the correct language identifier after the first set of backticks.' +
         ' If you decide to include a code block, make sure to explain what it is doing.',
-    schema: {
-        type: 'object',
-        properties: {
-            answer: { type: 'string' },
-        },
-        required: ['answer'],
-        additionalProperties: false,
-    } satisfies JSONSchema7,
-    handler: handleChat,
+    schema: z.object({
+        answer: z.string(),
+    }),
+    handler(ctx) {
+        const answer = ctx.data.params.answer;
+
+        if (requestCancelled) {
+            return actionHandlerFailure('Request was cancelled');
+        }
+
+        lastChatResponse = answer;
+        logOutput('INFO', 'Received chat response:\n' + answer);
+        return actionHandlerSuccess();
+    },
     validators: {
         sync: [
             () => NEURO.currentActionForce // This is done before the action force is cleared
@@ -92,7 +84,7 @@ export const chatAction: RCEAction = {
     category: 'Chat',
     hidden: true,
     defaultPermission: PermissionLevel.OFF, // Used with overridePermissions in forceActions
-} as const;
+});
 
 export function registerChatParticipant() {
     const handler: vscode.ChatRequestHandler = async (

src/chat.ts

@@ -1,37 +1,37 @@
 import * as vscode from 'vscode';
+import { ActionForcePriorityEnum } from 'neuro-game-sdk';
+import { z } from 'zod';
+
 import { NEURO } from '@/constants';
 import { logOutput, simpleFileName, getPositionContext, formatContext, NeuroPositionContext } from '@/utils/misc';
 import { CONFIG, CONNECTION, PermissionLevel } from '@/config';
-import { JSONSchema7 } from 'json-schema';
-import { actionHandlerFailure, actionHandlerSuccess, actionValidationAccept, actionValidationFailure, actionValidationRetry, RCEAction, RCEHandlerReturns } from '@/utils/neuro_client';
-import { RCEContext } from '@ctx/rce';
+import { actionHandlerFailure, actionHandlerSuccess, actionValidationAccept, actionValidationFailure, actionValidationRetry, defineAction } from '@/utils/neuro_client';
 import { abortActionForce, addActions, canForceActions, tryForceActions } from '@/rce';
-import { ActionForcePriorityEnum } from 'neuro-game-sdk';
 
 let lastSuggestions: string[] = [];
 let requestCancelled = false;
 
 // TODO: Figure out how to do this with maxCount
 // export const completionAction = (maxCount: number) => ({
-export const completeCodeAction: RCEAction = {
+export const completeCodeAction = defineAction({
     name: 'complete_code',
     description: 'Suggest code to write.' +
         ' Only one suggestion you provide will be chosen.' +
         ' Your suggestions can be single lines or multi-line code snippets.',
-    schema: {
-        type: 'object',
-        properties: {
-            suggestions: {
-                type: 'array',
-                items: { type: 'string' },
-                maxItems: 3,
-            },
-        },
-        required: ['suggestions'],
-        additionalProperties: false,
-    } satisfies JSONSchema7,
+    schema: z.object({
+        suggestions: z.array(z.string()).max(3),
+    }),
     category: 'Completions',
-    handler: handleCompleteCode,
+    handler(ctx) {
+        if (requestCancelled)
+            return actionHandlerFailure('Request was cancelled');
+        if (!NEURO.currentActionForce)
+            return actionHandlerFailure('Not currently waiting for suggestions');
+
+        lastSuggestions = ctx.data.params.suggestions;
+        logOutput('INFO', 'Received suggestions:\n' + JSON.stringify(lastSuggestions));
+        return actionHandlerSuccess();
+    },
     validators: {
         sync: [
             () => NEURO.currentActionForce // This is done before the action force is cleared
@@ -51,18 +51,7 @@ export const completeCodeAction: RCEAction = {
     promptGenerator: null, // Only ever run in Autopilot mode
     defaultPermission: PermissionLevel.OFF, // Used with overridePermissions in forceActions
     hidden: true,
-} as const;
-
-function handleCompleteCode(context: RCEContext): RCEHandlerReturns {
-    if (requestCancelled)
-        return actionHandlerFailure('Request was cancelled');
-    if (!NEURO.currentActionForce)
-        return actionHandlerFailure('Not currently waiting for suggestions');
-
-    lastSuggestions = context.data.params.suggestions;
-    logOutput('INFO', 'Received suggestions:\n' + JSON.stringify(lastSuggestions));
-    return actionHandlerSuccess();
-}
+});
 
 export function addCompleteCodeAction() {
     addActions([completeCodeAction], false);

src/completions.ts

@@ -1,7 +1,11 @@
 import * as vscode from 'vscode';
+
 import { NEURO } from '@/constants';
 import { logOutput } from '@/utils/misc';
 import { getAction } from '@/rce';
+import { PermissionLevel } from '@typing/actions';
+
+export { PermissionLevel }; // re-exporting for the sake of compat I'm done with this
 
 //#region Types
 
@@ -409,13 +413,6 @@ export async function checkDeprecatedSettings(version: string) {
     }
 }
 
-/** Permission level enums */
-export const enum PermissionLevel {
-    OFF = 0,
-    COPILOT = 1,
-    AUTOPILOT = 2,
-}
-
 export function permissionLevelToString(level: PermissionLevel): string {
     switch (level) {
         case PermissionLevel.AUTOPILOT:

src/config.ts

@@ -1,11 +1,11 @@
 import * as vscode from 'vscode';
-import { NeuroClient } from 'neuro-game-sdk';
+import { NeuroClient, type ActionData } from 'neuro-game-sdk';
+
 import { TerminalSession } from './pseudoterminal';
 import type { GitExtension } from '@typing/git.d';
 import { ActionsViewProvider } from '@views/actions';
 import { ImagesViewProvider } from '@views/image';
 import type { ExecuteViewProvider } from '@views/execute';
-import type { ActionData } from 'neuro-game-sdk';
 import type { ActionForceParams } from './utils/neuro_client';
 
 export interface NeuroTask {