ebay-api-mcp-server-node-local 1.0.0

package/README.md

@@ -0,0 +1,214 @@
+# eBay API MCP Server
+
+A Model Context Protocol (MCP) server that provides seamless integration with eBay's APIs through AI assistants and development tools.
+
+## Overview
+
+This MCP server enables AI assistants (Claude Desktop, Cursor, Cline, VS Code extensions, etc.) to interact with eBay's comprehensive API ecosystem. It provides tools for API document retrieval, endpoint discovery, and direct API invocation, making it easy to integrate eBay marketplace functionality into AI-powered workflows.
+
+### Key Features
+
+- **API Discovery**: Automatically discover and explore eBay API endpoints
+- **Dynamic Tool Generation**: Generate tools based on OpenAPI specifications
+- **Multi-Environment Support**: Works with both sandbox and production environments
+- **Comprehensive API Coverage**: Supports eBay's full API ecosystem
+- **Type-Safe Operations**: Built with TypeScript for robust API interactions
+- **MCP Integration**: Compatible with popular MCP hosts and AI assistants
+
+## Prerequisites
+
+- **Node.js**: Version 22 or higher
+- **eBay Developer Account**: Required for API access tokens
+- **MCP Host**: Claude Desktop, Cursor, Cline, or other MCP-compatible application
+
+## Installation
+
+### 1. Clone and Setup
+
+```bash
+git clone <repository-url>
+cd ebay-api-mcp-server-node-local
+npm install
+```
+
+### 2. Build the Project
+
+```bash
+npm run build
+# or
+yarn build
+```
+
+### 3. Environment Configuration
+
+Set the following environment variables:
+
+- `EBAY_CLIENT_TOKEN`: Your eBay API access token (required)
+- `EBAY_API_ENV`: API environment - "sandbox" or "production" (default: "production")
+
+## Authentication
+
+### Obtaining an eBay API Token
+
+#### Method 1: Using cURL
+
+```bash
+curl -v https://api.ebay.com/identity/v1/oauth2/token \
+  -H "Accept: application/json" \
+  -H "Accept-Language: en_US" \
+  -u "CLIENT_ID:CLIENT_SECRET" \
+  -d "grant_type=client_credentials"
+```
+
+For sandbox testing, use `https://api.sandbox.ebay.com/identity/v1/oauth2/token`
+
+#### Method 2: Using Postman
+
+1. Create a POST request to `https://api.ebay.com/identity/v1/oauth2/token`
+2. Set Authorization to Basic Auth with your Client ID and Client Secret
+3. Add form data: `grant_type=client_credentials`
+4. Send the request
+
+Response format:
+```json
+{
+    "access_token": "your_access_token_here",
+    "expires_in": 7200,
+    "token_type": "Application Access Token"
+}
+```
+
+## Usage
+
+### Running the Server
+
+#### With Environment Variables Set
+
+```bash
+npm start
+# or
+yarn start
+```
+
+#### With Inline Environment Variables
+
+```bash
+EBAY_CLIENT_TOKEN='your_token_here' EBAY_API_ENV='production' npm start
+```
+
+#### Using npx
+
+You can also run the server using `npx` in several ways:
+
+**Option 1: Run the built server directly**
+```bash
+# First build the project
+npm run build
+
+# Then run with npx
+npx node dist/index.js
+```
+
+**Option 2: Run with environment variables**
+```bash
+# Build first
+npm run build
+
+# Run with environment variables
+EBAY_CLIENT_TOKEN='your_token_here' EBAY_API_ENV='production' npx node dist/index.js
+```
+
+**Option 3: Use npx to run npm scripts**
+```bash
+npx npm run build
+npx npm start
+```
+
+**Option 4: Run TypeScript directly (if you have ts-node)**
+```bash
+npx ts-node src/index.ts
+```
+
+## MCP Integration
+
+### Configuration for Popular MCP Hosts
+
+#### VS Code with MCP Extension
+
+1. Create a `.vscode` folder in your project root
+2. Create `mcp.json` with the following configuration:
+
+```json
+{
+    "servers": {
+        "ebay-api-mcp-server": {
+            "type": "stdio",
+            "command": "node",
+            "args": ["./dist/index.js"],
+            "env": {
+                "EBAY_API_ENV": "production",
+                "EBAY_CLIENT_TOKEN": "YOUR_ACCESS_TOKEN"
+            }
+        }
+    }
+}
+```
+
+#### Claude Desktop
+
+Add to your Claude Desktop MCP configuration:
+
+```json
+{
+    "mcpServers": {
+        "ebay-api": {
+            "command": "node",
+            "args": ["/path/to/ebay-api-mcp-server/dist/index.js"],
+            "env": {
+                "EBAY_CLIENT_TOKEN": "YOUR_ACCESS_TOKEN",
+                "EBAY_API_ENV": "production"
+            }
+        }
+    }
+}
+```
+
+#### Cursor
+
+Configure in your Cursor MCP settings with similar JSON structure as above.
+
+### Example Usage
+
+Once configured, you can ask your AI assistant to:
+
+- "Find an API for marketplace account deletion notifications"
+- "Search for product listing APIs"
+- "Get documentation for the Trading API"
+- "Invoke the getBuyerRequirements endpoint"
+
+## Troubleshooting
+
+### Common Issues
+
+**Authentication Errors**
+- Verify your `EBAY_CLIENT_TOKEN` is valid and not expired
+- Ensure you're using the correct environment (sandbox vs production)
+- Check that your eBay developer account has the necessary permissions
+
+**MCP Connection Issues**
+- Verify the path to `dist/index.js` in your MCP configuration
+- Ensure Node.js is in your system PATH
+- Check that the server builds successfully with `npm run build`
+
+**API Errors**
+- Review eBay API documentation for endpoint-specific requirements
+- Verify your token has the necessary scopes for the APIs you're trying to access
+- Check rate limiting and usage quotas
+
+
+## Support
+
+For issues related to:
+- **eBay API**: Consult the [eBay Developer Documentation](https://developer.ebay.com/)
+- **MCP Protocol**: Visit the [Model Context Protocol documentation](https://modelcontextprotocol.io/)
+- **This Server**: Open an issue in this repository

package/dist/constant/constants.js

@@ -0,0 +1,48 @@
+/**
+ * Constants used throughout the application
+ */
+/**
+ * Environment options for the eBay API
+ */
+export var ApiEnvironment;
+(function (ApiEnvironment) {
+    ApiEnvironment["SANDBOX"] = "sandbox";
+    ApiEnvironment["PRODUCTION"] = "production";
+})(ApiEnvironment || (ApiEnvironment = {}));
+/**
+ * Utility to find ApiEnvironment by string value
+ * Returns SANDBOX if no match is found
+ */
+export function findApiEnvironmentByValue(value) {
+    const lowercaseValue = value?.toLowerCase();
+    const matchedEnv = Object.entries(ApiEnvironment)
+        .find(([_key, val]) => typeof val === "string" && val.toLowerCase() === lowercaseValue);
+    return matchedEnv ? matchedEnv[1] : ApiEnvironment.SANDBOX;
+}
+/**
+ * Recall apiDoc url by prompt
+ */
+export const RECALL_SPEC_BY_PROMPT_URL = "https://ebaypubapimcp3.vip.qa.ebay.com/developer-portal/api/v1/openapi-specs/search?query=%s";
+/**
+ * url for query apiSpec with fields such as specTitle、operationId
+ */
+export const RECALL_SPEC_WITH_FIELD_URL = "https://ebaypubapimcp3.vip.qa.ebay.com/developer-portal/api/v1/openapi-specs/%s?operationId=%s";
+/**
+ * Required environment variable names for the application
+ */
+export const REQUIRED_ENV_VARS = ["EBAY_CLIENT_TOKEN", "EBAY_API_ENV"];
+/**
+ * API domain name, differentiated by api environment
+ */
+export const DOMAIN_NAME = {
+    [ApiEnvironment.SANDBOX]: "api.sandbox.ebay.com",
+    [ApiEnvironment.PRODUCTION]: "api.ebay.com",
+};
+/**
+ * List of supported calling methods, differentiated by api environment
+ */
+export const SUPPORTED_CALLING_METHODS = {
+    [ApiEnvironment.SANDBOX]: ["get", "put", "post", "delete", "options", "head", "patch", "trace"],
+    [ApiEnvironment.PRODUCTION]: ["get"],
+};
+//# sourceMappingURL=constants.js.map

package/dist/constant/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constant/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,2CAAyB,CAAA;AAC3B,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AACD;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,MAAM,cAAc,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC;SAC9C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;IAC1F,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC;AAC/E,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,8FAA8F,CAAC;AACxI;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,gGAAgG,CAAC;AAE3I;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB;IAChD,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,cAAc;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;IAC/F,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC;CACrC,CAAC"}

package/dist/helper/http-helper.js

@@ -0,0 +1,140 @@
+/**
+ * Helper functions for HTTP requests
+ */
+import axios from "axios";
+import { DOMAIN_NAME, findApiEnvironmentByValue } from "../constant/constants.js";
+const USER_ENVIRONMENT = findApiEnvironmentByValue(process.env.EBAY_API_ENV || "");
+const USER_TOKEN = process.env.EBAY_CLIENT_TOKEN || "";
+const SCHEMA_REQUEST_BODY = "requestBody";
+/**
+ * Format axios error message for consistent error output
+ */
+export function formatAxiosError(error) {
+    let errorMessage = `Error in invokeAPI tool: ${error instanceof Error ? error.message : String(error)}`;
+    if (axios.isAxiosError(error)) {
+        if (error?.response?.data) {
+            errorMessage = JSON.stringify(error.response.data, null, 2);
+        }
+    }
+    return errorMessage;
+}
+/**
+ * Build headers from input headers and fill with default headers
+ */
+export function buildHeadersFromInput(inputHeaders) {
+    const headers = {};
+    if (inputHeaders) {
+        for (const [key, value] of Object.entries(inputHeaders)) {
+            headers[key] = Array.isArray(value) ? value[0] : value;
+        }
+    }
+    // Add default headers
+    fillDefaultHeaderInfo(headers);
+    return headers;
+}
+export function fillDefaultHeaderInfo(headers) {
+    headers["Host"] = DOMAIN_NAME[USER_ENVIRONMENT];
+    headers["User-Agent"] = "EBAY-API-MCP-Tool/1.0";
+    headers["Authorization"] = `Bearer ${USER_TOKEN}`;
+    headers["Content-Type"] = headers["Content-Type"] || "application/json";
+}
+/**
+ * Build final URL by replacing path variables with their values
+ */
+export function buildFinalUrl(url, urlVariables) {
+    if (urlVariables) {
+        for (const [key, value] of Object.entries(urlVariables)) {
+            url = url.replace(new RegExp(`%7B${key}%7D`, "g"), encodeURIComponent(String(value)));
+        }
+    }
+    return url;
+}
+/**
+ * replace url domain name by environment
+ */
+export function replaceDomainNameByEnvironment(url) {
+    try {
+        const urlObj = new URL(url);
+        const currentHostname = urlObj.hostname;
+        const expectedDomain = DOMAIN_NAME[USER_ENVIRONMENT];
+        if (currentHostname !== expectedDomain) {
+            urlObj.hostname = expectedDomain;
+            return urlObj.toString();
+        }
+        return url;
+    }
+    catch (error) {
+        // Fallback to string replacement if URL parsing fails
+        const expectedDomain = DOMAIN_NAME[USER_ENVIRONMENT];
+        for (const [env, domain] of Object.entries(DOMAIN_NAME)) {
+            if (env !== USER_ENVIRONMENT && url.includes(domain)) {
+                return url.replace(domain, expectedDomain);
+            }
+        }
+        return url;
+    }
+}
+/**
+ * Build base URL from OpenAPI servers object
+ */
+export function buildBaseUrlFromOpenApi(openapi) {
+    const serverObj = openapi.servers?.[0] || { url: "" };
+    let baseUrl = serverObj.url;
+    if (serverObj.variables) {
+        for (const [key, value] of Object.entries(serverObj.variables)) {
+            baseUrl = baseUrl.replace(`{${key}}`, value.default);
+        }
+    }
+    return replaceDomainNameByEnvironment(baseUrl);
+}
+/**
+ * Resolve path variables in a URL pattern
+ */
+export function resolvePath(pathPattern, pathVariables) {
+    if (!pathVariables) {
+        return pathPattern;
+    }
+    return pathPattern.replace(/{([^}]+)}/g, (match, key) => {
+        const value = pathVariables[key];
+        if (value === undefined) {
+            throw new Error(`Missing path variable: ${key}`);
+        }
+        return String(value);
+    });
+}
+/**
+ * Prepare request data
+ */
+export function prepareRequestData(input, operation, path) {
+    let resolvedPath = path;
+    const headers = {};
+    const params = {};
+    let data = undefined;
+    const pathParams = {};
+    let prop = input.properties || {};
+    Object.entries(prop).forEach(([key, value]) => {
+        if (key === SCHEMA_REQUEST_BODY) {
+            data = value;
+        }
+        else {
+            const paramDef = operation.parameters?.find(p => !("$ref" in p) && p.name === key);
+            if (paramDef) {
+                if (paramDef.in === "header") {
+                    headers[key] = String(value);
+                }
+                else if (paramDef.in === "query") {
+                    params[key] = value;
+                }
+                else if (paramDef.in === "path") {
+                    pathParams[key] = String(value);
+                }
+            }
+        }
+    });
+    fillDefaultHeaderInfo(headers);
+    if (Object.keys(pathParams).length > 0) {
+        resolvedPath = resolvePath(resolvedPath, pathParams);
+    }
+    return { resolvedPath, headers, params, data };
+}
+//# sourceMappingURL=http-helper.js.map

package/dist/helper/http-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-helper.js","sourceRoot":"","sources":["../../src/helper/http-helper.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAElF,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;AACnF,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC;AACvD,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAG1C;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,YAAY,GAAG,4BAA4B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IACxG,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,IAAI,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC1B,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAkD;IACtF,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,IAAI,YAAY,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACzD,CAAC;IACH,CAAC;IACD,sBAAsB;IACtB,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAA+B;IACnE,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAChD,OAAO,CAAC,YAAY,CAAC,GAAG,uBAAuB,CAAC;IAChD,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,UAAU,EAAE,CAAC;IAClD,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,kBAAkB,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,YAAiD;IAC1F,IAAI,YAAY,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,GAAW;IACxD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC;QACxC,MAAM,cAAc,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACrD,IAAI,eAAe,KAAK,cAAc,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC;YACjC,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3B,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,sDAAsD;QACtD,MAAM,cAAc,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACrD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,IAAI,GAAG,KAAK,gBAAgB,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrD,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAA2B;IACjE,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;IACtD,IAAI,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC;IAC5B,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACxB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IACD,OAAO,8BAA8B,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,WAAmB,EAAE,aAA+C;IAC9F,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACtD,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAA8B,EAC9B,SAAoC,EACpC,IAAY;IAEZ,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,IAAI,IAAI,GAAY,SAAS,CAAC;IAC9B,MAAM,UAAU,GAA2B,EAAE,CAAC;IAE9C,IAAI,IAAI,GAAG,KAAK,CAAC,UAAqC,IAAI,EAAE,CAAC;IAC7D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC5C,IAAI,GAAG,KAAK,mBAAmB,EAAE,CAAC;YAChC,IAAI,GAAG,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAC9C,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,GAAG,CAA0C,CAAC;YAC7E,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,QAAQ,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;oBAC7B,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;qBAAM,IAAI,QAAQ,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;oBACnC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACtB,CAAC;qBAAM,IAAI,QAAQ,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;oBAClC,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvC,YAAY,GAAG,WAAW,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACjD,CAAC"}

package/dist/helper/openapi-helper.js

@@ -0,0 +1,114 @@
+/**
+ * OpenAPI helper functions, including loading OpenAPI documents,
+ * parsing OpenAPI specs, building schemas, and converting to Zod schemas.
+ */
+import SwaggerParser from "@apidevtools/swagger-parser";
+import * as fs from "fs";
+import axios from "axios";
+import * as yaml from "js-yaml";
+import util from "util";
+import { z } from "zod";
+const SCHEMA_REQUEST_BODY = "requestBody";
+/**
+ * Get OpenAPI docs from user config file, which contains urls or paths of OpenAPI specs.
+ */
+export async function getOpenApiDocumentsFromConfigFile() {
+    const docs = [];
+    const urlFile = process.env.EBAY_API_DOC_URL_FILE;
+    let urls = [];
+    if (urlFile && fs.existsSync(urlFile)) {
+        // url or path each line in the file
+        urls = fs.readFileSync(urlFile, "utf-8").split(/\r?\n/)
+            .map(line => line.trim())
+            .filter(line => line.length > 0 && !line.startsWith("#"));
+    }
+    console.error("Loading OpenAPI specifications from:", urls);
+    // parse opebapi doc from url/path
+    for (const specPath of urls) {
+        try {
+            const doc = await SwaggerParser.dereference(specPath);
+            docs.push(doc);
+        }
+        catch (e) {
+            console.error(`getOpenApiDocumentsFromConfigFile#[Failed to load OpenAPI doc from the specPath : ${specPath}]`);
+        }
+    }
+    return docs;
+}
+// Helper: remove ignored keys recursively
+export function readSchema2Map(obj) {
+    const SCHEMA_IGNORE_KEYS = ["style", "explode", "exampleSetFlag", "types", "in", "required"];
+    if (Array.isArray(obj)) {
+        return obj.map(readSchema2Map);
+    }
+    else if (obj && typeof obj === "object") {
+        const out = {};
+        for (const [k, v] of Object.entries(obj)) {
+            if (!SCHEMA_IGNORE_KEYS.includes(k)) {
+                out[k] = readSchema2Map(v);
+            }
+        }
+        return out;
+    }
+    return obj;
+}
+/**
+ * Parse OpenAPI document from string (supports both JSON and YAML)
+ */
+export async function parseOpenApiDoc(specTitle, operationId, specUrl) {
+    const url = util.format(specUrl, specTitle, operationId);
+    const apiSpecRes = await axios.get(url, {
+        httpsAgent: new (await import("https")).Agent({
+            rejectUnauthorized: false,
+        })
+    });
+    const docString = apiSpecRes.data;
+    try {
+        // Try parsing as JSON first
+        return JSON.parse(docString);
+    }
+    catch (jsonError) {
+        try {
+            // If JSON fails, try parsing as YAML
+            return yaml.load(docString);
+        }
+        catch (yamlError) {
+            const _jsonMsg = jsonError instanceof Error ? jsonError.message : String(jsonError);
+            const _yamlMsg = yamlError instanceof Error ? yamlError.message : String(yamlError);
+            console.error("failed to parse OpenAPI document !!!");
+            return {};
+        }
+    }
+}
+/**
+ * Build schema for an operation's input parameters
+ */
+export function buildOperationSchema(operation) {
+    const properties = {};
+    // handle request param
+    (operation.parameters || []).forEach(param => {
+        if ("$ref" in param) {
+            return;
+        }
+        const paramSchema = readSchema2Map(param);
+        properties[param.name] = paramSchema;
+    });
+    // handle request body
+    if (operation.requestBody && "content" in operation.requestBody &&
+        operation.requestBody.content?.["application/json"]?.schema) {
+        const requestBodySchema = readSchema2Map(operation.requestBody.content["application/json"].schema);
+        properties[SCHEMA_REQUEST_BODY] = requestBodySchema;
+    }
+    return { properties };
+}
+/**
+ * Build Zod validation schema
+ */
+export function buildZodSchema(properties) {
+    const zodProperties = {};
+    Object.keys(properties).forEach(key => {
+        zodProperties[key] = z.any();
+    });
+    return zodProperties;
+}
+//# sourceMappingURL=openapi-helper.js.map

package/dist/helper/openapi-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-helper.js","sourceRoot":"","sources":["../../src/helper/openapi-helper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAExD,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,CAAC,EAAmB,MAAM,KAAK,CAAC;AAGzC,MAAM,mBAAmB,GAAG,aAAa,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC;IACrD,MAAM,IAAI,GAAyB,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IAClD,IAAI,IAAI,GAAa,EAAE,CAAC;IACxB,IAAI,OAAO,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,oCAAoC;QACpC,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;aACpD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aACxB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IAC5D,kCAAkC;IAClC,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAuB,CAAC;YAC5E,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,qFAAqF,QAAQ,GAAG,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0CAA0C;AAC1C,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC7F,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACjC,CAAC;SAAM,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAA8B,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpC,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,SAAiB,EAAE,WAAoB,EAAE,OAAe;IAC5F,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,GAAG,CAAS,GAAG,EAAG;QAC/C,UAAU,EAAE,IAAI,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YAC5C,kBAAkB,EAAE,KAAK;SAC1B,CAAC;KAAC,CAAC,CAAC;IACP,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC;IAClC,IAAI,CAAC;QACH,4BAA4B;QAC5B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAuB,CAAC;IACrD,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,qCAAqC;YACrC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAuB,CAAC;QACpD,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,MAAM,QAAQ,GAAG,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACpF,MAAM,QAAQ,GAAG,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACpF,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACtD,OAAO,EAAwB,CAAC;QAClC,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAoC;IACvE,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,uBAAuB;IACvB,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC3C,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YAAA,OAAO;QAAA,CAAC;QAC9B,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;QAC1C,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,sBAAsB;IACtB,IAAI,SAAS,CAAC,WAAW,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW;QAC3D,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;QAChE,MAAM,iBAAiB,GAAG,cAAc,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;QACnG,UAAU,CAAC,mBAAmB,CAAC,GAAG,iBAAiB,CAAC;IACtD,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,UAAmC;IAChE,MAAM,aAAa,GAA+B,EAAE,CAAC;IAErD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACpC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC;AACvB,CAAC"}