@alacard-project/shared 1.0.0

package/proto/config.proto

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package config;
+
+service ConfigService {
+  rpc GetConfig (GetConfigRequest) returns (ConfigResponse);
+  rpc SetConfig (SetConfigRequest) returns (ConfigResponse);
+  rpc ListConfigs (ListConfigsRequest) returns (ListConfigsResponse);
+}
+
+message GetConfigRequest {
+  string serviceName = 1;
+  string environment = 2;
+  string version = 3;
+}
+
+message ConfigResponse {
+  map<string, string> values = 1;
+}
+
+message SetConfigRequest {
+  string serviceName = 1;
+  string environment = 2;
+  string key = 3;
+  string value = 4;
+}
+
+message ListConfigsRequest {
+  string environment = 1;
+}
+
+message ServiceConfig {
+  string serviceName = 1;
+  map<string, string> values = 2;
+}
+
+message ListConfigsResponse {
+  repeated ServiceConfig configs = 1;
+}

package/proto/dbf.proto

@@ -0,0 +1,183 @@
+syntax = "proto3";
+
+package dbf;
+
+// ==================== Service Definition ====================
+
+service Dbf Service {
+  // Read DBF file with optional filtering
+  rpc ReadDbf(ReadDbfRequest) returns (ReadDbfResponse);
+  
+  // Update a single field in specific record(s)
+  rpc UpdateField(UpdateFieldRequest) returns (UpdateFieldResponse);
+  
+  // Batch update multiple records
+  rpc BatchUpdate(BatchUpdateRequest) returns (BatchUpdateResponse);
+  
+  // Get DBF file schema/structure
+  rpc GetSchema(GetSchemaRequest) returns (GetSchemaResponse);
+  
+  // List available DBF files
+  rpc ListFiles(ListFilesRequest) returns (ListFilesResponse);
+  
+  // Pack DBF - remove deleted records (PACK in FoxPro)
+  rpc Pack(PackRequest) returns (PackResponse);
+  
+  // Reindex DBF - rebuild indexes (REINDEX in FoxPro)
+  rpc Reindex(ReindexRequest) returns (ReindexResponse);
+  
+  // Mark record for deletion (DELETE in FoxPro)
+  rpc MarkForDeletion(MarkForDeletionRequest) returns (MarkForDeletionResponse);
+}
+
+// ==================== Read Operations ====================
+
+message ReadDbfRequest {
+  string filename = 1;
+  optional string filter = 2; // JSON filter conditions
+  optional int32 limit = 3;
+  optional int32 offset = 4;
+}
+
+message ReadDbfResponse {
+  bool success = 1;
+  repeated Record records = 2;
+  int32 total = 3;
+  optional string error = 4;
+}
+
+message Record {
+  map<string, string> fields = 1; // Field name -> value
+}
+
+// ==================== Update Operations ====================
+
+message UpdateFieldRequest {
+  string filename = 1;
+  string field_name = 2;
+  string new_value = 3;
+  optional string filter = 4; // JSON filter to identify records
+  optional int32 record_index = 5; // Direct record index
+  string user_id = 6; // For audit logging
+}
+
+message UpdateFieldResponse {
+  bool success = 1;
+  int32 records_updated = 2;
+  optional string backup_path = 3;
+  optional string error = 4;
+}
+
+message BatchUpdateRequest {
+  string filename = 1;
+  repeated FieldUpdate updates = 2;
+  string user_id = 3;
+}
+
+message FieldUpdate {
+  int32 record_index = 1;
+  string field_name = 2;
+  string new_value = 3;
+}
+
+message BatchUpdateResponse {
+  bool success = 1;
+  int32 records_updated = 2;
+  int32 records_failed = 3;
+  repeated FailedUpdate failures = 4;
+  optional string backup_path = 5;
+  optional string error = 6;
+}
+
+message FailedUpdate {
+  int32 record_index = 1;
+  string error = 2;
+}
+
+// ==================== Schema Operations ====================
+
+message GetSchemaRequest {
+  string filename = 1;
+}
+
+message GetSchemaResponse {
+  bool success = 1;
+  repeated FieldDefinition fields = 2;
+  int32 record_count = 3;
+  optional string error = 4;
+}
+
+message FieldDefinition {
+  string name = 1;
+  string type = 2; // C, N, L, D, etc.
+  int32 length = 3;
+  int32 decimal_count = 4;
+}
+
+// ==================== File Listing ====================
+
+message ListFilesRequest {
+  optional string directory = 1;
+}
+
+message ListFilesResponse {
+  bool success = 1;
+  repeated DbfFile files = 2;
+  optional string error = 3;
+}
+
+message DbfFile {
+  string filename = 1;
+  string path = 2;
+  int64 size_bytes = 3;
+  int32 record_count = 4;
+  string last_modified = 5; // ISO string
+}
+
+// ==================== Pack Operation ====================
+
+message PackRequest {
+  string filename = 1;
+  string user_id = 2;
+}
+
+message PackResponse {
+  bool success = 1;
+  int32 records_before = 2;
+  int32 records_after = 3;
+  int32 removed_count = 4;
+  optional string backup_path = 5;
+  optional string error = 6;
+}
+
+// ==================== Reindex Operation ====================
+
+message ReindexRequest {
+  string filename = 1;
+  optional string index_field = 2; // Specific field to reindex
+  optional string user_id = 3;
+}
+
+message ReindexResponse {
+  bool success = 1;
+  string message = 2;
+  repeated string index_files = 3; // .CDX, .IDX files found
+  optional string recommendation = 4;
+  optional string error = 5;
+}
+
+// ==================== Mark for Deletion ====================
+
+message MarkForDeletionRequest {
+  string filename = 1;
+  int32 record_index = 2;
+  string user_id = 3;
+}
+
+message MarkForDeletionResponse {
+  bool success = 1;
+  int32 record_index = 2;
+  bool marked_for_deletion = 3;
+  optional string backup_path = 4;
+  optional string error = 5;
+}

package/proto/logging.proto

@@ -0,0 +1,143 @@
+syntax = "proto3";
+
+package logging;
+
+service LoggingService {
+  // Log a service event
+  rpc LogEvent (LogEventRequest) returns (LogEventResponse);
+  
+  // Log user action for audit trail
+  rpc LogUserAction (LogUserActionRequest) returns (LogUserActionResponse);
+  
+  // Update service health status
+  rpc UpdateServiceStatus (UpdateServiceStatusRequest) returns (UpdateServiceStatusResponse);
+  
+  // Query service logs
+  rpc GetServiceLogs (GetServiceLogsRequest) returns (GetServiceLogsResponse);
+  
+  // Get service health status
+  rpc GetServiceStatus (GetServiceStatusRequest) returns (GetServiceStatusResponse);
+  
+  // Query user actions
+  rpc GetUserActions (GetUserActionsRequest) returns (GetUserActionsResponse);
+}
+
+// Log Event Messages
+message LogEventRequest {
+  string serviceId = 1;
+  string serviceName = 2;
+  string level = 3; // DEBUG, INFO, WARN, ERROR, FATAL
+  string message = 4;
+  string metadata = 5; // JSON string
+  optional string userId = 6;
+  optional string requestId = 7;
+}
+
+message LogEventResponse {
+  bool success = 1;
+  string logId = 2;
+}
+
+// User Action Messages
+message LogUserActionRequest {
+  string userId = 1;
+  string userName = 2;
+  string action = 3;
+  string resource = 4;
+  optional string details = 5; // JSON string
+  optional string ipAddress = 6;
+  optional string userAgent = 7;
+}
+
+message LogUserActionResponse {
+  bool success = 1;
+  string actionId = 2;
+}
+
+// Service Status Messages
+message UpdateServiceStatusRequest {
+  string serviceName = 1;
+  string status = 2; // HEALTHY, DEGRADED, DOWN, UNKNOWN
+  optional string version = 3;
+  optional int32 uptime = 4;
+  optional string metadata = 5; // JSON string
+}
+
+message UpdateServiceStatusResponse {
+  bool success = 1;
+  string statusId = 2;
+}
+
+// Query Messages
+message GetServiceLogsRequest {
+  optional string serviceName = 1;
+  optional string level = 2;
+  optional string userId = 3;
+  optional string requestId = 4;
+  optional string startDate = 5; // ISO 8601 format
+  optional string endDate = 6;   // ISO 8601 format
+  optional int32 limit = 7;
+  optional int32 offset = 8;
+}
+
+message ServiceLogEntry {
+  string id = 1;
+  string serviceId = 2;
+  string serviceName = 3;
+  string level = 4;
+  string message = 5;
+  string metadata = 6;
+  string timestamp = 7;
+  optional string userId = 8;
+  optional string requestId = 9;
+}
+
+message GetServiceLogsResponse {
+  repeated ServiceLogEntry logs = 1;
+  int32 total = 2;
+}
+
+message GetServiceStatusRequest {
+  optional string serviceName = 1;
+}
+
+message ServiceStatusEntry {
+  string id = 1;
+  string serviceName = 2;
+  string status = 3;
+  string lastHeartbeat = 4;
+  optional string version = 5;
+  optional int32 uptime = 6;
+  optional string metadata = 7;
+}
+
+message GetServiceStatusResponse {
+  repeated ServiceStatusEntry statuses = 1;
+}
+
+message GetUserActionsRequest {
+  optional string userId = 1;
+  optional string action = 2;
+  optional string resource = 3;
+  optional string startDate = 4;
+  optional string endDate = 5;
+  optional int32 limit = 6;
+  optional int32 offset = 7;
+}
+
+message UserActionEntry {
+  string id = 1;
+  string userId = 2;
+  string userName = 3;
+  string action = 4;
+  string resource = 5;
+  string details = 6;
+  string timestamp = 7;
+  optional string ipAddress = 8;
+  optional string userAgent = 9;
+}
+
+message GetUserActionsResponse {
+  repeated UserActionEntry actions = 1;
+  int32 total = 2;
+}

package/proto/token.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package token;
+
+service TokenService {
+  rpc GenerateTokens (GenerateTokensRequest) returns (TokensResponse);
+  rpc ValidateToken (ValidateTokenRequest) returns (ValidateTokenResponse);
+  rpc RefreshTokens (RefreshTokensRequest) returns (TokensResponse);
+  rpc RevokeToken (RevokeTokenRequest) returns (RevokeTokenResponse);
+}
+
+message GenerateTokensRequest {
+  string userId = 1;
+  string email = 2;
+  string role = 3;
+  repeated string scopes = 4;
+  string status = 5;
+}
+
+message TokensResponse {
+  string accessToken = 1;
+  string refreshToken = 2;
+}
+
+message ValidateTokenRequest {
+  string token = 1;
+}
+
+message ValidateTokenResponse {
+  bool isValid = 1;
+  string userId = 2;
+  string role = 3;
+  repeated string scopes = 4;
+  string status = 5;
+}
+
+message RefreshTokensRequest {
+  string refreshToken = 1;
+  string userAgent = 2;
+  string ipAddress = 3;
+}
+
+message RevokeTokenRequest {
+  string userId = 1;
+  string refreshToken = 2;
+}
+
+message RevokeTokenResponse {
+  bool success = 1;
+}

package/proto/user.proto

@@ -0,0 +1,87 @@
+syntax = "proto3";
+
+package user;
+
+service UserService {
+  rpc GetUserById(GetUserByIdRequest) returns (UserResponse);
+  rpc GetUserByEmail(GetUserByEmailRequest) returns (UserResponse);
+  rpc GetUserPermissions(GetUserPermissionsRequest) returns (PermissionsResponse);
+  rpc CreateUser(CreateUserRequest) returns (UserResponse);
+  rpc UpdateUser(UpdateUserRequest) returns (UserResponse);
+  rpc UpdateProfile(UpdateProfileRequest) returns (UserResponse);
+  rpc DeleteUser(DeleteUserRequest) returns (DeleteUserResponse);
+}
+
+message GetUserByIdRequest {
+  string userId = 1;
+}
+
+message GetUserByEmailRequest {
+  string email = 1;
+}
+
+message GetUserPermissionsRequest {
+  string userId = 1;
+}
+
+message CreateUserRequest {
+  string email = 1;
+  string password = 2;
+  string name = 3;
+  string role = 4;
+}
+
+message UpdateUserRequest {
+  string userId = 1;
+  optional string name = 2;
+  optional string email = 3;
+  optional string role = 4;
+  optional bool isActive = 5;
+  optional string password = 6;
+}
+
+message UpdateProfileRequest {
+  string userId = 1;
+  optional string name = 2;
+  optional string phone = 3;
+  optional string avatar = 4;
+  optional string metadata = 5;
+}
+
+message DeleteUserRequest {
+  string userId = 1;
+}
+
+message UserResponse {
+  string id = 1;
+  string email = 2;
+  string name = 3;
+  string role = 4;
+  bool isActive = 5;
+  string createdAt = 6;
+  string updatedAt = 7;
+  string password = 8;
+  string lastName = 9;
+  string firstName = 10;
+  optional string middleName = 11;
+  string shortName = 12;
+  optional string internalPhone = 13;
+  optional string mobilePhone = 14;
+  optional string facsimileSignature = 15;
+}
+
+message DeleteUserResponse {
+  bool success = 1;
+}
+
+message Permission {
+  string id = 1;
+  string resource = 2;
+  string action = 3;
+}
+
+message PermissionsResponse {
+  string userId = 1;
+  repeated Permission permissions = 2;
+  repeated string scopes = 3;
+}

package/src/constants/env.constants.ts

@@ -0,0 +1,25 @@
+export const ENV_KEYS = {
+    NODE_ENV: 'NODE_ENV',
+    PORT: 'PORT',
+    DATABASE_URL: 'DATABASE_URL',
+    REDIS_HOST: 'REDIS_HOST',
+    REDIS_PORT: 'REDIS_PORT',
+    REDIS_PASSWORD: 'REDIS_PASSWORD',
+    KAFKA_BROKERS: 'KAFKA_BROKERS',
+    RABBITMQ_URL: 'RABBITMQ_URL',
+    JWT_SECRET: 'JWT_SECRET',
+    GRPC_PORT: 'GRPC_PORT',
+    GRPC_URL: 'GRPC_URL',
+    LOGGING_PROTO_PATH: 'LOGGING_PROTO_PATH',
+    INTERNAL_CONFIG_KEY: 'INTERNAL_CONFIG_KEY',
+    RATE_LIMIT_TTL: 'RATE_LIMIT_TTL',
+    RATE_LIMIT_MAX: 'RATE_LIMIT_MAX',
+    CORS_ORIGINS: 'CORS_ORIGINS',
+} as const;
+
+export const ENV_VALUES = {
+    DEVELOPMENT: 'development',
+    PRODUCTION: 'production',
+    TEST: 'test',
+    STAGING: 'staging',
+} as const;

package/src/constants/grpc.constants.ts

@@ -0,0 +1,15 @@
+export const GRPC_PACKAGES = {
+    LOGGING: 'logging',
+    CONFIG: 'config',
+} as const;
+
+export const GRPC_METHODS = {
+    LOGGING: {
+        LOG_EVENT: 'LogEvent',
+        LOG_USER_ACTION: 'LogUserAction',
+        UPDATE_SERVICE_STATUS: 'UpdateServiceStatus',
+        GET_SERVICE_LOGS: 'GetServiceLogs',
+        GET_SERVICE_STATUS: 'GetServiceStatus',
+        GET_USER_ACTIONS: 'GetUserActions',
+    },
+} as const;

package/src/constants/http.constants.ts

@@ -0,0 +1,11 @@
+export const HTTP_METHODS = {
+    GET: 'GET',
+    POST: 'POST',
+    PUT: 'PUT',
+    DELETE: 'DELETE',
+    PATCH: 'PATCH',
+} as const;
+
+export const API_PREFIX = {
+    V1: '/api/v1',
+} as const;

package/src/constants/index.ts

@@ -0,0 +1,5 @@
+export * from './env.constants';
+export * from './http.constants';
+export * from './services.constants';
+export * from './grpc.constants';
+export * from './logging.constants';

package/src/constants/logging.constants.ts

@@ -0,0 +1,26 @@
+export const LOG_RETENTION_PERIODS = {
+    SHORT: 7,
+    MEDIUM: 30,
+    LONG: 90,
+} as const;
+
+export const LOG_CLEANUP_MESSAGES = {
+    SUCCESS: 'Logs cleaned up successfully',
+    INVALID_DATE_RANGE: 'Invalid date range',
+    NO_LOGS_FOUND: 'No logs found for cleanup',
+    CLEANUP_STARTED: 'Log cleanup started',
+    CLEANUP_COMPLETED: 'Log cleanup completed',
+    CLEANUP_FAILED: 'Log cleanup failed',
+    FILE_CLEANUP_SUCCESS: 'File cleanup successful',
+    FILE_CLEANUP_FAILED: 'File cleanup failed',
+    RETENTION_UPDATED: 'Retention period updated',
+} as const;
+
+export const LOGGING_ERROR_MESSAGES = {
+    LOG_EVENT_FAILED: 'Failed to log event',
+    LOG_USER_ACTION_FAILED: 'Failed to log user action',
+    UPDATE_SERVICE_STATUS_FAILED: 'Failed to update service status',
+    GET_SERVICE_LOGS_FAILED: 'Failed to get service logs',
+    GET_SERVICE_STATUS_FAILED: 'Failed to get service status',
+    GET_USER_ACTIONS_FAILED: 'Failed to get user actions',
+} as const;

package/src/constants/services.constants.ts

@@ -0,0 +1,6 @@
+export const MICROSERVICES = {
+    CONFIG: 'CONFIG_SERVICE',
+    LOGGING: 'LOGGING_SERVICE',
+    AUTH: 'AUTH_SERVICE',
+    USER: 'USER_SERVICE',
+} as const;

package/src/contracts/config.contract.ts

@@ -0,0 +1,14 @@
+export interface GetConfigRequest {
+    serviceName: string;
+    environment: string;
+    version: string;
+}
+
+export interface ConfigResponse {
+    values: Record<string, string>;
+}
+
+export interface ListConfigsResponse {
+    service: string;
+    values: Record<string, string>;
+}

package/src/contracts/index.ts

@@ -0,0 +1,2 @@
+export * from './config.contract';
+export * from './logging.contract';