aiox-core 5.0.3 → 5.0.4

package/.aiox-core/development/templates/service-template/errors.ts.hbs

@@ -1,182 +1,182 @@
-/**
- * Error definitions for {{pascalCase serviceName}} service.
- * @module @aiox/{{kebabCase serviceName}}/errors
- * @story {{storyId}}
- */
-
-/**
- * Error codes for {{pascalCase serviceName}} service.
- */
-export enum {{pascalCase serviceName}}ErrorCode {
-  /** Configuration is missing or invalid */
-  CONFIGURATION_ERROR = 'CONFIGURATION_ERROR',
-
-  /** Network or connectivity issue */
-  NETWORK_ERROR = 'NETWORK_ERROR',
-
-  /** Operation timed out */
-  TIMEOUT_ERROR = 'TIMEOUT_ERROR',
-
-  /** Feature not yet implemented */
-  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
-
-  /** Unknown or unexpected error */
-  UNKNOWN_ERROR = 'UNKNOWN_ERROR',
-
-{{#if isApiIntegration}}
-  /** API rate limit exceeded */
-  RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED',
-
-  /** API authentication failed */
-  AUTHENTICATION_ERROR = 'AUTHENTICATION_ERROR',
-
-  /** API authorization failed */
-  AUTHORIZATION_ERROR = 'AUTHORIZATION_ERROR',
-
-  /** API returned an error response */
-  API_ERROR = 'API_ERROR',
-
-  /** Invalid API response format */
-  INVALID_RESPONSE = 'INVALID_RESPONSE',
-{{/if}}
-}
-
-/**
- * Custom error class for {{pascalCase serviceName}} service.
- */
-export class {{pascalCase serviceName}}Error extends Error {
-  /**
-   * Error code for programmatic handling.
-   */
-  public readonly code: {{pascalCase serviceName}}ErrorCode;
-
-  /**
-   * Additional error details.
-   */
-  public readonly details?: Record<string, unknown>;
-
-  /**
-   * Original error that caused this error.
-   */
-  public readonly cause?: Error;
-
-{{#if isApiIntegration}}
-  /**
-   * HTTP status code (for API errors).
-   */
-  public readonly statusCode?: number;
-
-  /**
-   * Rate limit information (for rate limit errors).
-   */
-  public readonly rateLimit?: {
-    remaining: number;
-    reset: number;
-  };
-{{/if}}
-
-  constructor(
-    message: string,
-    code: {{pascalCase serviceName}}ErrorCode = {{pascalCase serviceName}}ErrorCode.UNKNOWN_ERROR,
-    options?: {
-      details?: Record<string, unknown>;
-      cause?: Error;
-{{#if isApiIntegration}}
-      statusCode?: number;
-      rateLimit?: { remaining: number; reset: number };
-{{/if}}
-    }
-  ) {
-    super(message);
-    this.name = '{{pascalCase serviceName}}Error';
-    this.code = code;
-    this.details = options?.details;
-    this.cause = options?.cause;
-{{#if isApiIntegration}}
-    this.statusCode = options?.statusCode;
-    this.rateLimit = options?.rateLimit;
-{{/if}}
-
-    // Maintains proper stack trace for where error was thrown
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, {{pascalCase serviceName}}Error);
-    }
-  }
-
-  /**
-   * Returns a JSON representation of the error.
-   */
-  toJSON(): Record<string, unknown> {
-    return {
-      name: this.name,
-      code: this.code,
-      message: this.message,
-      details: this.details,
-      cause: this.cause ? { name: this.cause.name, message: this.cause.message } : undefined,
-{{#if isApiIntegration}}
-      statusCode: this.statusCode,
-      rateLimit: this.rateLimit,
-{{/if}}
-    };
-  }
-}
-
-/**
- * Factory functions for creating typed errors.
- */
-export const {{pascalCase serviceName}}Errors = {
-  /**
-   * Create a configuration error.
-   */
-  configurationError(message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR, { details });
-  },
-
-  /**
-   * Create a network error.
-   */
-  networkError(message: string, cause?: Error): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.NETWORK_ERROR, { cause });
-  },
-
-  /**
-   * Create a timeout error.
-   */
-  timeoutError(message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.TIMEOUT_ERROR, { details });
-  },
-
-{{#if isApiIntegration}}
-  /**
-   * Create a rate limit error.
-   */
-  rateLimitError(retryAfter: number, rateLimit: { remaining: number; reset: number }): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(
-      `Rate limit exceeded. Retry after ${retryAfter} seconds.`,
-      {{pascalCase serviceName}}ErrorCode.RATE_LIMIT_EXCEEDED,
-      { statusCode: 429, rateLimit }
-    );
-  },
-
-  /**
-   * Create an authentication error.
-   */
-  authenticationError(message: string = 'Authentication failed'): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.AUTHENTICATION_ERROR, { statusCode: 401 });
-  },
-
-  /**
-   * Create an authorization error.
-   */
-  authorizationError(message: string = 'Access denied'): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.AUTHORIZATION_ERROR, { statusCode: 403 });
-  },
-
-  /**
-   * Create an API error from response.
-   */
-  apiError(statusCode: number, message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
-    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.API_ERROR, { statusCode, details });
-  },
-{{/if}}
-};
+/**
+ * Error definitions for {{pascalCase serviceName}} service.
+ * @module @aiox/{{kebabCase serviceName}}/errors
+ * @story {{storyId}}
+ */
+
+/**
+ * Error codes for {{pascalCase serviceName}} service.
+ */
+export enum {{pascalCase serviceName}}ErrorCode {
+  /** Configuration is missing or invalid */
+  CONFIGURATION_ERROR = 'CONFIGURATION_ERROR',
+
+  /** Network or connectivity issue */
+  NETWORK_ERROR = 'NETWORK_ERROR',
+
+  /** Operation timed out */
+  TIMEOUT_ERROR = 'TIMEOUT_ERROR',
+
+  /** Feature not yet implemented */
+  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
+
+  /** Unknown or unexpected error */
+  UNKNOWN_ERROR = 'UNKNOWN_ERROR',
+
+{{#if isApiIntegration}}
+  /** API rate limit exceeded */
+  RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED',
+
+  /** API authentication failed */
+  AUTHENTICATION_ERROR = 'AUTHENTICATION_ERROR',
+
+  /** API authorization failed */
+  AUTHORIZATION_ERROR = 'AUTHORIZATION_ERROR',
+
+  /** API returned an error response */
+  API_ERROR = 'API_ERROR',
+
+  /** Invalid API response format */
+  INVALID_RESPONSE = 'INVALID_RESPONSE',
+{{/if}}
+}
+
+/**
+ * Custom error class for {{pascalCase serviceName}} service.
+ */
+export class {{pascalCase serviceName}}Error extends Error {
+  /**
+   * Error code for programmatic handling.
+   */
+  public readonly code: {{pascalCase serviceName}}ErrorCode;
+
+  /**
+   * Additional error details.
+   */
+  public readonly details?: Record<string, unknown>;
+
+  /**
+   * Original error that caused this error.
+   */
+  public readonly cause?: Error;
+
+{{#if isApiIntegration}}
+  /**
+   * HTTP status code (for API errors).
+   */
+  public readonly statusCode?: number;
+
+  /**
+   * Rate limit information (for rate limit errors).
+   */
+  public readonly rateLimit?: {
+    remaining: number;
+    reset: number;
+  };
+{{/if}}
+
+  constructor(
+    message: string,
+    code: {{pascalCase serviceName}}ErrorCode = {{pascalCase serviceName}}ErrorCode.UNKNOWN_ERROR,
+    options?: {
+      details?: Record<string, unknown>;
+      cause?: Error;
+{{#if isApiIntegration}}
+      statusCode?: number;
+      rateLimit?: { remaining: number; reset: number };
+{{/if}}
+    }
+  ) {
+    super(message);
+    this.name = '{{pascalCase serviceName}}Error';
+    this.code = code;
+    this.details = options?.details;
+    this.cause = options?.cause;
+{{#if isApiIntegration}}
+    this.statusCode = options?.statusCode;
+    this.rateLimit = options?.rateLimit;
+{{/if}}
+
+    // Maintains proper stack trace for where error was thrown
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, {{pascalCase serviceName}}Error);
+    }
+  }
+
+  /**
+   * Returns a JSON representation of the error.
+   */
+  toJSON(): Record<string, unknown> {
+    return {
+      name: this.name,
+      code: this.code,
+      message: this.message,
+      details: this.details,
+      cause: this.cause ? { name: this.cause.name, message: this.cause.message } : undefined,
+{{#if isApiIntegration}}
+      statusCode: this.statusCode,
+      rateLimit: this.rateLimit,
+{{/if}}
+    };
+  }
+}
+
+/**
+ * Factory functions for creating typed errors.
+ */
+export const {{pascalCase serviceName}}Errors = {
+  /**
+   * Create a configuration error.
+   */
+  configurationError(message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR, { details });
+  },
+
+  /**
+   * Create a network error.
+   */
+  networkError(message: string, cause?: Error): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.NETWORK_ERROR, { cause });
+  },
+
+  /**
+   * Create a timeout error.
+   */
+  timeoutError(message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.TIMEOUT_ERROR, { details });
+  },
+
+{{#if isApiIntegration}}
+  /**
+   * Create a rate limit error.
+   */
+  rateLimitError(retryAfter: number, rateLimit: { remaining: number; reset: number }): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(
+      `Rate limit exceeded. Retry after ${retryAfter} seconds.`,
+      {{pascalCase serviceName}}ErrorCode.RATE_LIMIT_EXCEEDED,
+      { statusCode: 429, rateLimit }
+    );
+  },
+
+  /**
+   * Create an authentication error.
+   */
+  authenticationError(message: string = 'Authentication failed'): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.AUTHENTICATION_ERROR, { statusCode: 401 });
+  },
+
+  /**
+   * Create an authorization error.
+   */
+  authorizationError(message: string = 'Access denied'): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.AUTHORIZATION_ERROR, { statusCode: 403 });
+  },
+
+  /**
+   * Create an API error from response.
+   */
+  apiError(statusCode: number, message: string, details?: Record<string, unknown>): {{pascalCase serviceName}}Error {
+    return new {{pascalCase serviceName}}Error(message, {{pascalCase serviceName}}ErrorCode.API_ERROR, { statusCode, details });
+  },
+{{/if}}
+};

package/.aiox-core/development/templates/service-template/index.ts.hbs

@@ -1,120 +1,120 @@
-/**
- * @module @aiox/{{kebabCase serviceName}}
- * @description {{description}}
- * @story {{storyId}}
- */
-
-// Re-export types
-export * from './types';
-
-// Re-export errors
-export * from './errors';
-
-{{#if isApiIntegration}}
-// Re-export client (API integrations only)
-export { {{pascalCase serviceName}}Client } from './client';
-{{/if}}
-
-import type { {{pascalCase serviceName}}Config, {{pascalCase serviceName}}Service } from './types';
-import { {{pascalCase serviceName}}Error, {{pascalCase serviceName}}ErrorCode } from './errors';
-{{#if isApiIntegration}}
-import { {{pascalCase serviceName}}Client } from './client';
-{{/if}}
-
-/**
- * Creates a new {{pascalCase serviceName}} service instance.
- *
- * @param config - Service configuration
- * @returns Configured service instance
- * @throws {{{pascalCase serviceName}}Error} If configuration is invalid
- *
- * @example
- * ```typescript
- * const service = create{{pascalCase serviceName}}Service({
- *   // configuration options
- * });
- *
- * const result = await service.execute();
- * ```
- */
-export function create{{pascalCase serviceName}}Service(
-  config: {{pascalCase serviceName}}Config
-): {{pascalCase serviceName}}Service {
-  // Validate configuration
-  validateConfig(config);
-
-{{#if isApiIntegration}}
-  // Create API client
-  const client = new {{pascalCase serviceName}}Client(config);
-
-{{/if}}
-  return {
-    /**
-     * Execute the primary service operation.
-     */
-    async execute(): Promise<void> {
-      // TODO: Implement primary operation
-      throw new {{pascalCase serviceName}}Error(
-        'Not implemented',
-        {{pascalCase serviceName}}ErrorCode.NOT_IMPLEMENTED
-      );
-    },
-
-    /**
-     * Get the current configuration (without sensitive values).
-     */
-    getConfig(): Partial<{{pascalCase serviceName}}Config> {
-      return {
-        // Return non-sensitive config values
-{{#each envVars}}
-{{#unless this.sensitive}}
-        {{camelCase this.name}}: config.{{camelCase this.name}},
-{{/unless}}
-{{/each}}
-      };
-    },
-
-    /**
-     * Check if the service is properly configured and operational.
-     */
-    async healthCheck(): Promise<boolean> {
-      try {
-{{#if isApiIntegration}}
-        // Verify API connectivity
-        await client.ping();
-{{/if}}
-        return true;
-      } catch {
-        return false;
-      }
-    },
-  };
-}
-
-/**
- * Validates the service configuration.
- * @throws {{{pascalCase serviceName}}Error} If configuration is invalid
- */
-function validateConfig(config: {{pascalCase serviceName}}Config): void {
-  if (!config) {
-    throw new {{pascalCase serviceName}}Error(
-      'Configuration is required',
-      {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR
-    );
-  }
-
-{{#each envVars}}
-{{#if this.required}}
-  if (config.{{camelCase this.name}} === undefined || config.{{camelCase this.name}} === null) {
-    throw new {{pascalCase serviceName}}Error(
-      '{{this.name}} is required',
-      {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR
-    );
-  }
-
-{{/if}}
-{{/each}}
-}
-
-// Default export
-export default create{{pascalCase serviceName}}Service;
+/**
+ * @module @aiox/{{kebabCase serviceName}}
+ * @description {{description}}
+ * @story {{storyId}}
+ */
+
+// Re-export types
+export * from './types';
+
+// Re-export errors
+export * from './errors';
+
+{{#if isApiIntegration}}
+// Re-export client (API integrations only)
+export { {{pascalCase serviceName}}Client } from './client';
+{{/if}}
+
+import type { {{pascalCase serviceName}}Config, {{pascalCase serviceName}}Service } from './types';
+import { {{pascalCase serviceName}}Error, {{pascalCase serviceName}}ErrorCode } from './errors';
+{{#if isApiIntegration}}
+import { {{pascalCase serviceName}}Client } from './client';
+{{/if}}
+
+/**
+ * Creates a new {{pascalCase serviceName}} service instance.
+ *
+ * @param config - Service configuration
+ * @returns Configured service instance
+ * @throws {{{pascalCase serviceName}}Error} If configuration is invalid
+ *
+ * @example
+ * ```typescript
+ * const service = create{{pascalCase serviceName}}Service({
+ *   // configuration options
+ * });
+ *
+ * const result = await service.execute();
+ * ```
+ */
+export function create{{pascalCase serviceName}}Service(
+  config: {{pascalCase serviceName}}Config
+): {{pascalCase serviceName}}Service {
+  // Validate configuration
+  validateConfig(config);
+
+{{#if isApiIntegration}}
+  // Create API client
+  const client = new {{pascalCase serviceName}}Client(config);
+
+{{/if}}
+  return {
+    /**
+     * Execute the primary service operation.
+     */
+    async execute(): Promise<void> {
+      // TODO: Implement primary operation
+      throw new {{pascalCase serviceName}}Error(
+        'Not implemented',
+        {{pascalCase serviceName}}ErrorCode.NOT_IMPLEMENTED
+      );
+    },
+
+    /**
+     * Get the current configuration (without sensitive values).
+     */
+    getConfig(): Partial<{{pascalCase serviceName}}Config> {
+      return {
+        // Return non-sensitive config values
+{{#each envVars}}
+{{#unless this.sensitive}}
+        {{camelCase this.name}}: config.{{camelCase this.name}},
+{{/unless}}
+{{/each}}
+      };
+    },
+
+    /**
+     * Check if the service is properly configured and operational.
+     */
+    async healthCheck(): Promise<boolean> {
+      try {
+{{#if isApiIntegration}}
+        // Verify API connectivity
+        await client.ping();
+{{/if}}
+        return true;
+      } catch {
+        return false;
+      }
+    },
+  };
+}
+
+/**
+ * Validates the service configuration.
+ * @throws {{{pascalCase serviceName}}Error} If configuration is invalid
+ */
+function validateConfig(config: {{pascalCase serviceName}}Config): void {
+  if (!config) {
+    throw new {{pascalCase serviceName}}Error(
+      'Configuration is required',
+      {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR
+    );
+  }
+
+{{#each envVars}}
+{{#if this.required}}
+  if (config.{{camelCase this.name}} === undefined || config.{{camelCase this.name}} === null) {
+    throw new {{pascalCase serviceName}}Error(
+      '{{this.name}} is required',
+      {{pascalCase serviceName}}ErrorCode.CONFIGURATION_ERROR
+    );
+  }
+
+{{/if}}
+{{/each}}
+}
+
+// Default export
+export default create{{pascalCase serviceName}}Service;