Add API Designer Extension

workspaces/api-designer/api-designer-core/package.json

@@ -12,13 +12,15 @@
   },
   "author": "WSO2",
   "devDependencies": {
-    "typescript": "5.8.3",
-    "@typescript-eslint/parser": "8.32.1",
+    "@types/js-yaml": "4.0.9",
     "@typescript-eslint/eslint-plugin": "8.32.1",
-    "eslint": "9.27.0"
+    "@typescript-eslint/parser": "8.32.1",
+    "eslint": "9.27.0",
+    "typescript": "5.8.3"
   },
   "dependencies": {
     "@types/vscode-webview": "1.57.3",
+    "js-yaml": "4.1.1",
     "vscode-messenger-common": "0.4.5"
   },
   "repository": {

workspaces/api-designer/api-designer-core/src/constants/default-spectral-rulesets.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2026, WSO2 LLC. (https://www.wso2.com) All Rights Reserved.
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import type { SpectralRuleset } from '../rpc-types/api-designer-visualizer/analyze';
+
+/** JSONPath / key inside each ruleset YAML where Spectral `rules` live */
+export const DEFAULT_SPECTRAL_RULESET_CONTENT_PATH = 'rulesetContent';
+
+function ruleset(
+    name: string,
+    fileName: string,
+    sourceFolder: string
+): SpectralRuleset {
+    return {
+        name,
+        sourceFolder,
+        fileName,
+        rulesetContentPath: DEFAULT_SPECTRAL_RULESET_CONTENT_PATH
+    };
+}
+
+/**
+ * Default governance rulesets when no `.api-platform/config.yaml` (or empty list) — Analyze / governance dashboards.
+ * Caller must provide the base source folder that contains bundled rulesets.
+ */
+export function getDefaultGovernanceSpectralRulesets(baseSourceFolder: string): SpectralRuleset[] {
+    const normalizedBase = (baseSourceFolder || '').replace(/[\\/]+$/, '');
+    return [
+        ruleset('WSO2 REST API AI Readiness Guidelines', 'ai-readiness.yaml', normalizedBase),
+        ruleset('OWASP Top 10 Security', 'owasp_top_10.yaml', normalizedBase),
+        ruleset('WSO2 REST API Design Guidelines', 'wso2_rest_api_design_guidelines.yaml', normalizedBase)
+    ];
+}

workspaces/api-designer/api-designer-core/src/index.ts

@@ -17,6 +17,7 @@
  */
 
 // export * from "./rpc";
+export * from "./constants/default-spectral-rulesets";
 export * from "./state-machine-types";
 export * from "./vscode";
 // ------ History class and interface -------->
@@ -25,3 +26,101 @@ export * from "./history";
 export * from "./rpc-types/api-designer-visualizer/index";
 export * from "./rpc-types/api-designer-visualizer/rpc-type";
 export * from "./rpc-types/api-designer-visualizer/types";
+// Explicit exports for RPC method names
+export {
+    getAPISpecContent,
+    writeAPISpecContent,
+    validateApiSpec,
+    fetchRulesetsFromFolder,
+    getApplicableRulesets,
+    readFile,
+    writeFile,
+    deleteFile,
+    getWorkspaceFileTree,
+    checkAIAvailability,
+    getAllSpectralRulesets,
+    getGovernance,
+    generateWithAI,
+} from "./rpc-types/api-designer-visualizer/rpc-type";
+
+// ------ Copilot RPC types -------->
+export * from "./utils/yaml-utils";
+// Export error handling utilities with explicit exports to avoid conflicts
+export {
+    APIDesignerError,
+    FileOperationError,
+    APIDesignerValidationError,
+    RPCError,
+    getErrorMessage,
+    getErrorCode,
+    isAPIDesignerError,
+    withErrorHandling
+} from "./utils/error-handling";
+
+// ------ AI Prompts -------->
+export * from "./utils/ai-prompts";
+// Explicit exports for new prompt functions to ensure they're available
+export {
+    buildFixValidationIssuesPrompt,
+    buildGenericEditPrompt
+} from "./utils/ai-prompts";
+export type {
+    ValidationFixContext,
+    GenericEditContext
+} from "./utils/ai-prompts";
+
+// ------ Core Utilities -------->
+export * from "./utils/spec-type-utils";
+export * from "./utils/spec-helpers";
+
+// ------ API Specification Support (OpenAPI) -------->
+export * from "./specs/constants";
+export * from "./specs/detector";
+export * from "./specs/specification-service";
+export * from "./specs/openapi-service";
+export * from "./specs/specification-factory";
+// Explicit exports for commonly used functions and types
+export { detectSpecType, detectSpecTypeFromPath } from "./specs/detector";
+export { ApiSpecType } from "./specs/constants";
+// Export types with explicit re-exports to avoid conflicts
+export type {
+    ApiSpecification,
+    SpecInfo,
+    SpecParseResult,
+    SpecValidationResult,
+    SpecComparisonResult,
+    SpecDifference
+} from "./specs/types";
+export type {
+    Info,
+    Contact,
+    License,
+    Server,
+    ServerVariable,
+    Schema,
+    ReferenceObject,
+    SecurityScheme,
+    OAuthFlows,
+    OAuthFlow,
+    SpecMetadata
+} from "./specs/common-types";
+export type {
+    OpenAPISpec,
+    Paths,
+    PathItem,
+    Operation as OpenAPIOperation,
+    Parameter as OpenAPIParameter,
+    RequestBody,
+    Responses,
+    Response,
+    MediaType,
+    Example,
+    Header,
+    Link,
+    EncodingProperty,
+    Components,
+    Callback,
+    SecurityRequirement,
+    Tag as OpenAPITag,
+    ExternalDocumentation as OpenAPIExternalDocumentation
+} from "./specs/openapi-types";