@autonomaai/api-schemas 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+/**
+ * autonoma API Schemas
+ *
+ * Unified API schemas and validation utilities for all autonoma services.
+ *
+ * This package normalizes API contracts across:
+ * - Hummingbot MCP Server
+ * - Backend API
+ * - Market Maker Agent
+ * - Data Collector
+ * - RAG Service
+ */
+export * from './validators';
+export { migrateLegacyExecuteSignal, convertToLegacyFormat, createValidationMiddleware, generatePythonValidator } from './validators';
+export type { ValidationResult, ValidationError } from './validators';
+export { validateSuccessResponse, validateErrorResponse, validateCreateControllerRequest, validateController, validateTradingSignal, validateExecuteSignalRequest } from './validators';
+export declare const API_SCHEMA_VERSION = "1.0.0";
+export declare const SUPPORTED_FORMATS: string[];
+export declare const SCHEMAS: {
+    readonly OPENAPI_SPEC: "openapi.yaml";
+    readonly JSON_SCHEMAS: "schemas/";
+    readonly GENERATED_TYPES: "generated-types.ts";
+};
+export declare const ENDPOINT_MIGRATIONS: {
+    readonly LEGACY_EXECUTE_SIGNAL: "/trading/execute-signal";
+    readonly LEGACY_CONTROLLER_SIGNAL: "/trading/{controller_id}/signal";
+    readonly UNIFIED_EXECUTE_SIGNAL: "/trading/signals/execute";
+};
+export declare const ERROR_CODES: {
+    readonly VALIDATION_FAILED: "VALIDATION_FAILED";
+    readonly CONTROLLER_NOT_FOUND: "CONTROLLER_NOT_FOUND";
+    readonly INVALID_SIGNAL: "INVALID_SIGNAL";
+    readonly EXCHANGE_ERROR: "EXCHANGE_ERROR";
+    readonly UNAUTHORIZED: "UNAUTHORIZED";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+};
+export declare const HTTP_STATUS: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly CONFLICT: 409;
+    readonly RATE_LIMITED: 429;
+    readonly INTERNAL_ERROR: 500;
+    readonly SERVICE_UNAVAILABLE: 503;
+};
+/**
+ * Create a standardized success response
+ */
+export declare function createSuccessResponse<T = any>(message: string, data?: T, additionalFields?: Record<string, any>): {
+    data?: (T & ({} | null)) | undefined;
+    success: boolean;
+    message: string;
+    timestamp: string;
+};
+/**
+ * Create a standardized error response
+ */
+export declare function createErrorResponse(error: string, detail?: string, errorCode?: string, additionalFields?: Record<string, any>): {
+    timestamp: string;
+    error_code?: string | undefined;
+    detail?: string | undefined;
+    success: boolean;
+    error: string;
+};
+/**
+ * Check if a response follows the standardized format
+ */
+export declare function isStandardizedResponse(response: any): boolean;
+/**
+ * Normalize a legacy response to the standardized format
+ */
+export declare function normalizeLegacyResponse(response: any): any;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,cAAc,cAAc,CAAC;AAG7B,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,gBAAgB,EAChB,eAAe,EAChB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,cAAc,CAAC;AAGtB,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAC1C,eAAO,MAAM,iBAAiB,UAA4C,CAAC;AAG3E,eAAO,MAAM,OAAO;;;;CAIV,CAAC;AAGX,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAGX,eAAO,MAAM,WAAW;;;;;;;;CAQd,CAAC;AAGX,eAAO,MAAM,WAAW;;;;;;;;;;;CAWd,CAAC;AAEX;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,GAAG,GAAG,EAC3C,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,CAAC,EACR,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;;EASvC;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;;;EAUvC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAO7D;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,CAwB1D"}

package/dist/index.js

@@ -0,0 +1,109 @@
+/**
+ * autonoma API Schemas
+ *
+ * Unified API schemas and validation utilities for all autonoma services.
+ *
+ * This package normalizes API contracts across:
+ * - Hummingbot MCP Server
+ * - Backend API
+ * - Market Maker Agent
+ * - Data Collector
+ * - RAG Service
+ */
+// Export validation utilities
+export * from './validators';
+// Export schema migration helpers
+export { migrateLegacyExecuteSignal, convertToLegacyFormat, createValidationMiddleware, generatePythonValidator } from './validators';
+// Export validation functions
+export { validateSuccessResponse, validateErrorResponse, validateCreateControllerRequest, validateController, validateTradingSignal, validateExecuteSignalRequest } from './validators';
+// Version and metadata
+export const API_SCHEMA_VERSION = '1.0.0';
+export const SUPPORTED_FORMATS = ['openapi-3.0.3', 'json-schema-draft-07'];
+// Schema format constants
+export const SCHEMAS = {
+    OPENAPI_SPEC: 'openapi.yaml',
+    JSON_SCHEMAS: 'schemas/',
+    GENERATED_TYPES: 'generated-types.ts'
+};
+// Endpoint normalization mappings
+export const ENDPOINT_MIGRATIONS = {
+    LEGACY_EXECUTE_SIGNAL: '/trading/execute-signal',
+    LEGACY_CONTROLLER_SIGNAL: '/trading/{controller_id}/signal',
+    UNIFIED_EXECUTE_SIGNAL: '/trading/signals/execute'
+};
+// Common error codes
+export const ERROR_CODES = {
+    VALIDATION_FAILED: 'VALIDATION_FAILED',
+    CONTROLLER_NOT_FOUND: 'CONTROLLER_NOT_FOUND',
+    INVALID_SIGNAL: 'INVALID_SIGNAL',
+    EXCHANGE_ERROR: 'EXCHANGE_ERROR',
+    UNAUTHORIZED: 'UNAUTHORIZED',
+    RATE_LIMITED: 'RATE_LIMITED',
+    INTERNAL_ERROR: 'INTERNAL_ERROR'
+};
+// Standard HTTP status codes
+export const HTTP_STATUS = {
+    OK: 200,
+    CREATED: 201,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    CONFLICT: 409,
+    RATE_LIMITED: 429,
+    INTERNAL_ERROR: 500,
+    SERVICE_UNAVAILABLE: 503
+};
+/**
+ * Create a standardized success response
+ */
+export function createSuccessResponse(message, data, additionalFields) {
+    return {
+        success: true,
+        message,
+        timestamp: new Date().toISOString(),
+        ...(data !== undefined && { data }),
+        ...additionalFields
+    };
+}
+/**
+ * Create a standardized error response
+ */
+export function createErrorResponse(error, detail, errorCode, additionalFields) {
+    return {
+        success: false,
+        error,
+        ...(detail && { detail }),
+        ...(errorCode && { error_code: errorCode }),
+        timestamp: new Date().toISOString(),
+        ...additionalFields
+    };
+}
+/**
+ * Check if a response follows the standardized format
+ */
+export function isStandardizedResponse(response) {
+    return (typeof response === 'object' &&
+        response !== null &&
+        typeof response.success === 'boolean' &&
+        typeof response.timestamp === 'string');
+}
+/**
+ * Normalize a legacy response to the standardized format
+ */
+export function normalizeLegacyResponse(response) {
+    // Already standardized
+    if (isStandardizedResponse(response)) {
+        return response;
+    }
+    // Handle common legacy patterns
+    if (response.status === 'success' || response.success === true) {
+        return createSuccessResponse(response.message || 'Operation completed successfully', response.data || response.result || response);
+    }
+    if (response.status === 'error' || response.error) {
+        return createErrorResponse(response.error || response.message || 'Operation failed', response.detail || response.description, response.error_code || response.code);
+    }
+    // Default: treat as successful data response
+    return createSuccessResponse('Operation completed successfully', response);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,8BAA8B;AAC9B,cAAc,cAAc,CAAC;AAE7B,kCAAkC;AAClC,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,cAAc,CAAC;AAQtB,8BAA8B;AAC9B,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,cAAc,CAAC;AAEtB,uBAAuB;AACvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;AAE3E,0BAA0B;AAC1B,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,YAAY,EAAE,UAAU;IACxB,eAAe,EAAE,oBAAoB;CAC7B,CAAC;AAEX,kCAAkC;AAClC,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,qBAAqB,EAAE,yBAAyB;IAChD,wBAAwB,EAAE,iCAAiC;IAC3D,sBAAsB,EAAE,0BAA0B;CAC1C,CAAC;AAEX,qBAAqB;AACrB,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,iBAAiB,EAAE,mBAAmB;IACtC,oBAAoB,EAAE,sBAAsB;IAC5C,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,YAAY,EAAE,cAAc;IAC5B,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAEX,6BAA6B;AAC7B,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,GAAG;IACP,OAAO,EAAE,GAAG;IACZ,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,GAAG;IACjB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,GAAG;IACd,QAAQ,EAAE,GAAG;IACb,YAAY,EAAE,GAAG;IACjB,cAAc,EAAE,GAAG;IACnB,mBAAmB,EAAE,GAAG;CAChB,CAAC;AAEX;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAe,EACf,IAAQ,EACR,gBAAsC;IAEtC,OAAO;QACL,OAAO,EAAE,IAAI;QACb,OAAO;QACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,CAAC;QACnC,GAAG,gBAAgB;KACpB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAa,EACb,MAAe,EACf,SAAkB,EAClB,gBAAsC;IAEtC,OAAO;QACL,OAAO,EAAE,KAAK;QACd,KAAK;QACL,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QACzB,GAAG,CAAC,SAAS,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QAC3C,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,GAAG,gBAAgB;KACpB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAa;IAClD,OAAO,CACL,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,CAAC,OAAO,KAAK,SAAS;QACrC,OAAO,QAAQ,CAAC,SAAS,KAAK,QAAQ,CACvC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,QAAa;IACnD,uBAAuB;IACvB,IAAI,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gCAAgC;IAChC,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAC/D,OAAO,qBAAqB,CAC1B,QAAQ,CAAC,OAAO,IAAI,kCAAkC,EACtD,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAC7C,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QAClD,OAAO,mBAAmB,CACxB,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,OAAO,IAAI,kBAAkB,EACxD,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,WAAW,EACvC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,IAAI,CACrC,CAAC;IACJ,CAAC;IAED,6CAA6C;IAC7C,OAAO,qBAAqB,CAAC,kCAAkC,EAAE,QAAQ,CAAC,CAAC;AAC7E,CAAC"}

package/dist/validators.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Schema validation utilities for autonoma API schemas.
+ *
+ * Provides runtime validation for API requests and responses using JSON Schema.
+ */
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    data?: any;
+}
+export interface ValidationError {
+    field: string;
+    message: string;
+    value?: any;
+    code: string;
+}
+/**
+ * Validate a success response
+ */
+export declare function validateSuccessResponse(data: any): ValidationResult;
+/**
+ * Validate an error response
+ */
+export declare function validateErrorResponse(data: any): ValidationResult;
+/**
+ * Validate create controller request
+ */
+export declare function validateCreateControllerRequest(data: any): ValidationResult;
+/**
+ * Validate controller object
+ */
+export declare function validateController(data: any): ValidationResult;
+/**
+ * Validate trading signal
+ */
+export declare function validateTradingSignal(data: any): ValidationResult;
+/**
+ * Validate execute signal request (UNIFIED)
+ */
+export declare function validateExecuteSignalRequest(data: any): ValidationResult;
+export declare function validateYieldOpportunity(data: any): ValidationResult;
+export declare function validateYieldSearchRequest(data: any): ValidationResult;
+export declare function validateAllocationOptimization(data: any): ValidationResult;
+export declare function validateDeFiSignal(data: any): ValidationResult;
+export declare function validatePortfolioRiskAssessment(data: any): ValidationResult;
+export declare function createYieldOpportunityResponse(opportunities: any[], metadata?: any): any;
+export declare function createAllocationOptimizationResponse(optimization: any, metadata?: any): any;
+export declare function createDeFiSignalResponse(execution_result: any, metadata?: any): any;
+/**
+ * Express middleware factory for request validation
+ */
+export declare function createValidationMiddleware(validator: (data: any) => ValidationResult): (req: any, res: any, next: any) => any;
+/**
+ * FastAPI dependency for request validation (Python equivalent helper)
+ */
+export declare function generatePythonValidator(schemaName: string): string;
+/**
+ * Convert legacy execute signal format to unified format
+ */
+export declare function migrateLegacyExecuteSignal(legacyData: any): any;
+/**
+ * Convert unified format to legacy format for backward compatibility
+ */
+export declare function convertToLegacyFormat(unifiedData: any, format: 'signal_type' | 'nested'): any;
+//# sourceMappingURL=validators.d.ts.map

package/dist/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAaH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAyZD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOnE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOjE;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAO3E;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAO9D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOjE;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOxE;AAMD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOpE;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAOtE;AAED,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAO1E;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAO9D;AAED,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,GAAG,GAAG,gBAAgB,CAO3E;AAMD,wBAAgB,8BAA8B,CAC5C,aAAa,EAAE,GAAG,EAAE,EACpB,QAAQ,CAAC,EAAE,GAAG,GACb,GAAG,CAcL;AAED,wBAAgB,oCAAoC,CAClD,YAAY,EAAE,GAAG,EACjB,QAAQ,CAAC,EAAE,GAAG,GACb,GAAG,CAaL;AAED,wBAAgB,wBAAwB,CACtC,gBAAgB,EAAE,GAAG,EACrB,QAAQ,CAAC,EAAE,GAAG,GACb,GAAG,CAaL;AAMD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,gBAAgB,IAC3E,KAAK,GAAG,EAAE,KAAK,GAAG,EAAE,MAAM,GAAG,SAetC;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAYlE;AAMD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,GAAG,GAAG,GAAG,CAiC/D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,GAAG,QAAQ,GAAG,GAAG,CAkB7F"}