@pulse-editor/cli 0.1.3 → 0.1.5

package/dist/lib/webpack/configs/utils.d.ts

@@ -1,3 +1,5 @@
+import type { TypedVariableType } from "@pulse-editor/shared-utils/dist/types/types.js";
+import { JSDoc } from "ts-morph";
 export declare function loadPulseConfig(): Promise<any>;
 export declare function getLocalNetworkIP(): string;
 export declare function readConfigFile(): Promise<any>;
@@ -7,4 +9,13 @@ export declare function discoverServerFunctions(): {
 export declare function discoverAppSkillActions(): {
     [x: string]: string;
 } | null;
+export declare function parseTypeDefs(jsDocs: JSDoc[]): Record<string, Record<string, {
+    type: string;
+    description: string;
+}>>;
+export declare function normalizeJSDocPropertyName(name: string | undefined): string | undefined;
+export declare function isPromiseLikeType(type: import("ts-morph").Type): boolean;
+export declare function unwrapPromiseLikeType(type: import("ts-morph").Type): import("ts-morph").Type<import("ts-morph").ts.Type>;
+export declare function getActionType(text: string): TypedVariableType;
+export declare function compileAppActionSkills(pulseConfig: any): void;
 export declare function generateTempTsConfig(): void;

package/dist/lib/webpack/configs/utils.js

@@ -1,10 +1,9 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { existsSync, writeFileSync } from "fs";
 import fs from "fs/promises";
 import { globSync } from "glob";
 import { networkInterfaces } from "os";
 import path from "path";
-import { Project, SyntaxKind } from "ts-morph";
+import { Node, Project, SyntaxKind } from "ts-morph";
 import ts from "typescript";
 import { pathToFileURL } from "url";
 export async function loadPulseConfig() {
@@ -143,6 +142,226 @@ export function discoverAppSkillActions() {
     }, {});
     return entryPoints;
 }
+export function parseTypeDefs(jsDocs) {
+    const typeDefs = {};
+    const typedefRegex = /@typedef\s+{([^}]+)}\s+([^\s-]+)/g;
+    const propertyRegex = /@property\s+{([^}]+)}\s+(\[?[^\]\s]+\]?)\s*-?\s*(.*)/g;
+    jsDocs.forEach((doc) => {
+        const text = doc.getFullText();
+        let typedefMatches;
+        while ((typedefMatches = typedefRegex.exec(text)) !== null) {
+            const typeName = typedefMatches[2];
+            if (!typeName)
+                continue;
+            const properties = {};
+            let propertyMatches;
+            while ((propertyMatches = propertyRegex.exec(text)) !== null) {
+                const propName = normalizeJSDocPropertyName(propertyMatches[2]);
+                const propType = propertyMatches[1];
+                const propDescription = propertyMatches[3] || "";
+                if (propName && propType) {
+                    properties[propName] = {
+                        type: propType,
+                        description: propDescription.trim(),
+                    };
+                }
+            }
+            typeDefs[typeName.toLowerCase()] = properties;
+        }
+    });
+    return typeDefs;
+}
+export function normalizeJSDocPropertyName(name) {
+    if (!name)
+        return "";
+    return name
+        .trim()
+        .replace(/^\[/, "")
+        .replace(/\]$/, "")
+        .split("=")[0]
+        ?.trim();
+}
+export function isPromiseLikeType(type) {
+    const symbolName = type.getSymbol()?.getName();
+    return symbolName === "Promise" || symbolName === "PromiseLike";
+}
+export function unwrapPromiseLikeType(type) {
+    const symbolName = type.getSymbol()?.getName();
+    if ((symbolName === "Promise" || symbolName === "PromiseLike") &&
+        type.getTypeArguments().length > 0) {
+        return type.getTypeArguments()[0] ?? type;
+    }
+    return type;
+}
+export function getActionType(text) {
+    if (text === "string")
+        return "string";
+    if (text === "number")
+        return "number";
+    if (text === "boolean")
+        return "boolean";
+    if (text === "any")
+        return "object";
+    if (text.endsWith("[]"))
+        return [getActionType(text.slice(0, -2))];
+    if (text.length === 0)
+        return "undefined";
+    console.warn(`[Type Warning] Unrecognized type "${text}". Consider adding explicit types in your action's JSDoc comments for better type safety and documentation.`);
+    return text;
+}
+export function compileAppActionSkills(pulseConfig) {
+    const files = globSync("./src/skill/*/action.ts");
+    const project = new Project({
+        tsConfigFilePath: path.join(process.cwd(), "node_modules/.pulse/tsconfig.server.json"),
+    });
+    const actions = [];
+    files.forEach((file) => {
+        const sourceFile = project.addSourceFileAtPath(file);
+        const defaultExportSymbol = sourceFile.getDefaultExportSymbol();
+        if (!defaultExportSymbol)
+            return;
+        const defaultExportDeclarations = defaultExportSymbol.getDeclarations();
+        defaultExportDeclarations.forEach((declaration) => {
+            if (declaration.getKind() !== SyntaxKind.FunctionDeclaration)
+                return;
+            const funcDecl = declaration.asKindOrThrow(SyntaxKind.FunctionDeclaration);
+            const pattern = /src\/skill\/([^\/]+)\/action\.ts$/;
+            const match = file.replaceAll("\\", "/").match(pattern);
+            if (!match) {
+                console.warn(`File path ${file} does not match pattern ${pattern}. Skipping...`);
+                return;
+            }
+            const actionName = match[1];
+            if (!actionName) {
+                console.warn(`Could not extract action name from file path ${file}. Skipping...`);
+                return;
+            }
+            if (actions.some((action) => action.name === actionName)) {
+                throw new Error(`Duplicate action name "${actionName}" detected in file ${file}. Please ensure all actions have unique names to avoid conflicts.`);
+            }
+            const defaultExportJSDocs = funcDecl.getJsDocs();
+            const descriptionText = defaultExportJSDocs
+                .map((doc) => doc.getDescription().replace(/^\*+/gm, "").trim())
+                .join("\n")
+                .trim();
+            if (defaultExportJSDocs.length === 0 || !descriptionText) {
+                throw new Error(`[Action Validation] Action "${actionName}" in ${file} is missing a JSDoc description. ` +
+                    `Please add a JSDoc comment block with a description above the function.` +
+                    `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+            }
+            const description = defaultExportJSDocs
+                .map((doc) => doc.getFullText())
+                .join("\n");
+            const allJSDocs = sourceFile.getDescendantsOfKind(SyntaxKind.JSDoc);
+            const typeDefs = parseTypeDefs(allJSDocs);
+            const funcParam = funcDecl.getParameters()[0];
+            const params = {};
+            if (funcParam) {
+                const defaults = new Map();
+                const nameNode = funcParam.getNameNode();
+                if (Node.isObjectBindingPattern(nameNode)) {
+                    nameNode.getElements().forEach((el) => {
+                        if (!Node.isBindingElement(el))
+                            return;
+                        const name = el.getName();
+                        const initializer = el.getInitializer()?.getText();
+                        if (initializer) {
+                            defaults.set(name, initializer);
+                        }
+                    });
+                }
+                const paramProperties = funcParam.getType().getProperties();
+                const inputTypeDef = typeDefs["input"] ?? {};
+                if (paramProperties.length > 0 && !typeDefs["input"]) {
+                    throw new Error(`[Action Validation] Action "${actionName}" in ${file} has parameters but is missing an ` +
+                        `"@typedef {Object} input" JSDoc block. Please document all parameters with ` +
+                        `@typedef {Object} input and @property tags.` +
+                        `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+                }
+                paramProperties.forEach((prop) => {
+                    const name = prop.getName();
+                    if (!inputTypeDef[name]) {
+                        throw new Error(`[Action Validation] Action "${actionName}" in ${file}: parameter "${name}" is missing ` +
+                            `a @property entry in the "input" JSDoc typedef. Please add ` +
+                            `"@property {type} ${name} - description" to the JSDoc.` +
+                            `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+                    }
+                    if (!inputTypeDef[name]?.description?.trim()) {
+                        throw new Error(`[Action Validation] Action "${actionName}" in ${file}: parameter "${name}" has an empty ` +
+                            `description in the JSDoc @property. Please provide a meaningful description.` +
+                            `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+                    }
+                    const variable = {
+                        description: inputTypeDef[name]?.description ?? "",
+                        type: getActionType(inputTypeDef[name]?.type ?? ""),
+                        optional: prop.isOptional() ? true : undefined,
+                        defaultValue: defaults.get(name),
+                    };
+                    params[name] = variable;
+                });
+            }
+            const rawReturnType = funcDecl.getReturnType();
+            const isPromiseLikeReturn = isPromiseLikeType(rawReturnType);
+            const returnType = unwrapPromiseLikeType(rawReturnType);
+            if (!returnType.isObject()) {
+                console.warn(`[Action Registration] Function ${actionName}'s return type should be an object. Skipping...`);
+                return;
+            }
+            const returns = {};
+            const returnProperties = returnType.getProperties();
+            const outputTypeDef = typeDefs["output"] ?? {};
+            const hasOutputTypeDef = !!typeDefs["output"];
+            if (returnProperties.length > 0 && !hasOutputTypeDef && !isPromiseLikeReturn) {
+                throw new Error(`[Action Validation] Action "${actionName}" in ${file} returns properties but is missing an ` +
+                    `"@typedef {Output}" JSDoc block. Please document all return values with ` +
+                    `@typedef {Output} and @property tags.` +
+                    `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+            }
+            if (returnProperties.length > 0 && !hasOutputTypeDef && isPromiseLikeReturn) {
+                console.warn(`[Action Validation] Action "${actionName}" in ${file} is missing an "@typedef {Object} output" JSDoc block. ` +
+                    `Falling back to TypeScript-inferred return metadata because the action returns a Promise.`);
+            }
+            returnProperties.forEach((prop) => {
+                const name = prop.getName();
+                if (!hasOutputTypeDef) {
+                    const variable = {
+                        description: "",
+                        type: getActionType(prop.getTypeAtLocation(funcDecl).getText()),
+                        optional: prop.isOptional() ? true : undefined,
+                        defaultValue: undefined,
+                    };
+                    returns[name] = variable;
+                    return;
+                }
+                if (!outputTypeDef[name]) {
+                    throw new Error(`[Action Validation] Action "${actionName}" in ${file}: return property "${name}" is missing ` +
+                        `a @property entry in the "output" JSDoc typedef. Please add ` +
+                        `"@property {type} ${name} - description" to the JSDoc.` +
+                        `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+                }
+                if (!outputTypeDef[name]?.description?.trim()) {
+                    throw new Error(`[Action Validation] Action "${actionName}" in ${file}: return property "${name}" has an empty ` +
+                        `description in the JSDoc @property. Please provide a meaningful description.` +
+                        `Run \`pulse skill fix ${actionName}\` to automatically add a JSDoc template for this action.`);
+                }
+                const variable = {
+                    description: outputTypeDef[name]?.description ?? "",
+                    type: getActionType(outputTypeDef[name]?.type ?? ""),
+                    optional: prop.isOptional() ? true : undefined,
+                    defaultValue: undefined,
+                };
+                returns[name] = variable;
+            });
+            actions.push({
+                name: actionName,
+                description,
+                parameters: params,
+                returns,
+            });
+        });
+    });
+    pulseConfig.actions = actions;
+}
 // Generate tsconfig for server functions
 export function generateTempTsConfig() {
     const tempTsConfigPath = path.join(process.cwd(), "node_modules/.pulse/tsconfig.server.json");

package/dist/lib/webpack/webpack-config.js

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { makeMFClientConfig } from "./configs/mf-client.js";
 import { makeMFServerConfig } from "./configs/mf-server.js";
-import { makePreviewClientConfig } from "./configs/preview.js";
+import { makeMFPreviewConfig, makePreviewClientConfig } from "./configs/preview.js";
 export async function createWebpackConfig(isPreview, buildTarget, mode) {
     if (isPreview) {
         const previewClientConfig = await makePreviewClientConfig("development");
-        const mfServerConfig = await makeMFServerConfig("development");
-        return [previewClientConfig, mfServerConfig];
+        const mfPreviewConfig = await makeMFPreviewConfig();
+        return [previewClientConfig, mfPreviewConfig];
     }
     else if (buildTarget === "server") {
         const mfServerConfig = await makeMFServerConfig(mode);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pulse-editor/cli",
-	"version": "0.1.3",
+	"version": "0.1.5",
 	"license": "MIT",
 	"bin": {
 		"pulse": "dist/cli.js"

package/dist/lib/server/utils.d.ts

@@ -1 +0,0 @@
-export declare function readConfigFile(): Promise<any>;

package/dist/lib/server/utils.js

@@ -1,17 +0,0 @@
-import fs from 'fs/promises';
-export async function readConfigFile() {
-    // Read pulse.config.json from dist/client
-    // Wait until dist/pulse.config.json exists
-    while (true) {
-        try {
-            await fs.access('dist/pulse.config.json');
-            break;
-        }
-        catch (err) {
-            // Wait for 100ms before trying again
-            await new Promise(resolve => setTimeout(resolve, 100));
-        }
-    }
-    const data = await fs.readFile('dist/pulse.config.json', 'utf-8');
-    return JSON.parse(data);
-}

package/dist/lib/webpack/dist/pregistered-actions.d.ts

@@ -1,2 +0,0 @@
-import { Action } from "@pulse-editor/shared-utils";
-export declare const preRegisteredActions: Record<string, Action>;

package/dist/lib/webpack/dist/pulse.config.d.ts

@@ -1,7 +0,0 @@
-import { AppConfig } from "@pulse-editor/shared-utils";
-/**
- * Pulse Editor Extension Config
- *
- */
-declare const config: AppConfig;
-export default config;

package/dist/lib/webpack/dist/src/lib/agents/code-modifier-agent.d.ts

@@ -1,2 +0,0 @@
-import { ChatPromptTemplate } from "@langchain/core/prompts";
-export declare const codeModifierAgentPrompt: ChatPromptTemplate<any, any>;

package/dist/lib/webpack/dist/src/lib/agents/vibe-coding-agent.d.ts

@@ -1,3 +0,0 @@
-import { MultiServerMCPClient } from "@langchain/mcp-adapters";
-import { MessageStreamController } from "../streaming/message-stream-controller";
-export declare function runVibeCoding(mcpClient: MultiServerMCPClient, userPrompt: string, controller: MessageStreamController): Promise<void>;

package/dist/lib/webpack/dist/src/lib/mcp/utils.d.ts

@@ -1,3 +0,0 @@
-import { MultiServerMCPClient } from "@langchain/mcp-adapters";
-export declare function writeFileToFS(mcpClient: MultiServerMCPClient, uri: string, content: string): Promise<string>;
-export declare function callTerminal(mcpClient: MultiServerMCPClient, command: string): Promise<string>;

package/dist/lib/webpack/dist/src/lib/streaming/message-stream-controller.d.ts

@@ -1,10 +0,0 @@
-import { AgentTaskMessageData } from "../types";
-export declare class MessageStreamController {
-    private controller;
-    private msgCounter;
-    private messages;
-    private timeCountMap;
-    constructor(controller: ReadableStreamDefaultController);
-    enqueueNew(data: AgentTaskMessageData, isFinal: boolean): number;
-    enqueueUpdate(data: AgentTaskMessageData, isFinal: boolean): void;
-}

package/dist/lib/webpack/dist/src/lib/types.d.ts

@@ -1,58 +0,0 @@
-export type VibeDevFlowNode = {
-    id: string;
-    children: VibeDevFlowNode[];
-};
-export declare enum AgentTaskMessageType {
-    Creation = "creation",
-    Update = "update"
-}
-export declare enum AgentTaskMessageDataType {
-    Notification = "notification",
-    ToolCall = "toolCall",
-    ArtifactOutput = "artifactOutput"
-}
-/**
- * Data associated with an AgentTaskItem.
- * The fields included depend on the type of the task item.
- *
- * @property type - The type of the task item, defined by the AgentTaskItemType enum.
- * @property title - (Optional) A brief title or summary of the task item.
- * @property description - (Optional) A detailed description of the task item.
- * @property toolName - (Optional) The name of the tool being called (if applicable).
- * @property parameters - (Optional) A record of parameters associated with the tool call (if applicable).
- * @property error - (Optional) An error message if the task item represents an error.
- * @property result - (Optional) The result or output of the task item (if applicable).
- */
-export type AgentTaskMessageData = {
-    type?: AgentTaskMessageDataType;
-    title?: string;
-    description?: string;
-    toolName?: string;
-    parameters?: Record<string, unknown>;
-    error?: string;
-    result?: string;
-};
-/**
- * Represents a single task item generated by the agent.
- * Each task item can be of different types such as tool calls, notifications, or errors.
- *
- * @property type - The type of the task item, defined by the AgentTaskItemType enum.
- * @property messageId - The unique identifier for the task item.
- * This is an incremental number representing the n-th task item.
- * @property data - The data associated with the task item, which varies based on the type.
- * @property isFinal - (Optional) Indicates if the task item is final and no further updates are expected.
- */
-export type AgentTaskMessage = {
-    type: AgentTaskMessageType;
-    messageId: number;
-    data: AgentTaskMessageData;
-    isFinal?: boolean;
-};
-export type AgentTaskMessageUpdate = {
-    type: AgentTaskMessageType;
-    messageId: number;
-    updateType: "append";
-    delta: AgentTaskMessageData;
-    isFinal?: boolean;
-    timeUsedSec?: string;
-};

package/dist/lib/webpack/dist/src/server-function/generate-code/v1/generate.d.ts

@@ -1,5 +0,0 @@
-/**
- *  An example function to echo the body of a POST request.
- *  This route is accessible at /server-function/echo
- */
-export default function generate(req: Request): Promise<Response>;

package/dist/lib/webpack/dist/src/server-function/generate-code/v2/generate.d.ts

@@ -1 +0,0 @@
-export default function handler(req: Request): Promise<Response>;

package/dist/lib/webpack/tsconfig.server.json

@@ -1,19 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2020",
-        "module": "esnext",
-        "moduleResolution": "bundler",
-        "strict": true,
-        "declaration": true,
-        "outDir": "dist",
-    },
-    "include": [
-        "../../../../../../src/server-function/**/*",
-        "../../../../../../pulse.config.ts",
-        "../../../../../../global.d.ts",
-    ],
-    "exclude": [
-        "../../../../../../node_modules",
-        "../../../../../../dist",
-    ]
-}

package/dist/lib/webpack/webpack.config.d.ts

@@ -1,2 +0,0 @@
-import wp from 'webpack';
-export declare function createWebpackConfig(isPreview: boolean, buildTarget: 'client' | 'server' | 'both', mode: 'development' | 'production'): Promise<wp.Configuration[]>;