@alacard-project/shared 1.1.7 → 1.1.9

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 DbfService {
+  // 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/iam.proto

@@ -0,0 +1,70 @@
+syntax = "proto3";
+
+package iam;
+
+service IamService {
+  rpc GetIdentity (GetIdentityRequest) returns (IdentityResponse);
+  rpc ListIdentities (ListIdentitiesRequest) returns (IdentitiesListResponse);
+  rpc CreateIdentity (CreateIdentityRequest) returns (IdentityResponse);
+  rpc UpdateIdentityStatus (UpdateStatusRequest) returns (IdentityResponse);
+  rpc AssignRole (RoleRequest) returns (SuccessResponse);
+  rpc RevokeRole (RoleRequest) returns (SuccessResponse);
+  rpc ListRoles (Empty) returns (RolesListResponse);
+}
+
+message Empty {}
+
+message GetIdentityRequest {
+  string id = 1;
+}
+
+message ListIdentitiesRequest {
+  int32 skip = 1;
+  int32 take = 2;
+  string roleId = 3;
+  string status = 4;
+  string subjectType = 5;
+}
+
+message CreateIdentityRequest {
+  string subjectType = 1;
+  string email = 2;
+  string password = 3;
+}
+
+message UpdateStatusRequest {
+  string id = 1;
+  string status = 2;
+}
+
+message RoleRequest {
+  string identityId = 1;
+  string roleId = 2;
+}
+
+message IdentityResponse {
+  string id = 1;
+  string subjectType = 2;
+  string status = 3;
+  string email = 4;
+  repeated Role roles = 5;
+  string createdAt = 6;
+}
+
+message Role {
+  string id = 1;
+  string name = 2;
+}
+
+message IdentitiesListResponse {
+  repeated IdentityResponse items = 1;
+  int32 total = 2;
+}
+
+message RolesListResponse {
+  repeated Role items = 1;
+}
+
+message SuccessResponse {
+  bool success = 1;
+}

package/proto/logging.proto

@@ -0,0 +1,153 @@
+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);
+
+  rpc GetMetrics (GetMetricsRequest) returns (GetMetricsResponse);
+}
+
+// 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;
+}
+
+message GetMetricsRequest {
+  string service_name = 1;
+}
+
+message GetMetricsResponse {
+  string metrics = 1;
+}

package/proto/notification.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package notification;
+
+service NotificationService {
+  rpc SendSync (NotificationRequest) returns (NotificationResponse);
+  rpc GetUserNotifications (GetUserNotificationsRequest) returns (GetUserNotificationsResponse);
+  rpc MarkAsRead (MarkAsReadRequest) returns (NotificationResponse);
+}
+
+message NotificationRequest {
+  string recipient = 1;
+  string type = 2; // email, sms, push, in_app
+  string template = 3;
+  map<string, string> payload = 4;
+  string priority = 5; // high, normal, low
+}
+
+message NotificationResponse {
+  bool success = 1;
+  string message = 2;
+  string notification_id = 3;
+}
+
+message GetUserNotificationsRequest {
+  string user_id = 1;
+}
+
+message NotificationItem {
+  string id = 1;
+  string type = 2;
+  string title = 3;
+  string message = 4;
+  bool is_read = 5;
+  string created_at = 6;
+}
+
+message GetUserNotificationsResponse {
+  repeated NotificationItem notifications = 1;
+}
+
+message MarkAsReadRequest {
+  string notification_id = 1;
+}

package/proto/partner.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package partner;
+
+service PartnerService {
+  rpc Create (CreatePartnerRequest) returns (PartnerResponse);
+  rpc FindAll (FindAllPartnersRequest) returns (PartnersListResponse);
+  rpc FindOne (FindOneRequest) returns (PartnerResponse);
+  rpc Update (UpdatePartnerRequest) returns (PartnerResponse);
+  rpc Remove (FindOneRequest) returns (RemovePartnerResponse);
+  rpc GetStats (GetStatsRequest) returns (PartnerStatsResponse);
+}
+
+message CreatePartnerRequest {
+  string name = 1;
+  string type = 2;
+  string email = 3;
+  string phone = 4;
+}
+
+message UpdatePartnerRequest {
+  string id = 1;
+  string name = 2;
+  string status = 3;
+}
+
+message FindAllPartnersRequest {
+  int32 page = 1;
+  int32 limit = 2;
+  string search = 3;
+}
+
+message FindOneRequest {
+  string id = 1;
+}
+
+message GetStatsRequest {}
+
+message PartnerResponse {
+  string id = 1;
+  string name = 2;
+  string bin = 3;
+  string type = 4;
+  string status = 5;
+  string contactPerson = 6;
+  string phone = 7;
+  string email = 8;
+  string address = 9;
+  double commission = 10;
+  double balance = 11;
+  string createdAt = 12;
+  string updatedAt = 13;
+}
+
+message PartnersListResponse {
+  repeated PartnerResponse partners = 1;
+  int32 total = 2;
+}
+
+message RemovePartnerResponse {
+  bool success = 1;
+}
+
+message PartnerStatsResponse {
+  int32 totalPartners = 1;
+  int32 activePartners = 2;
+  int32 pendingPartners = 3;
+}

package/proto/terminal.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package terminal;
+
+service TerminalService {
+  rpc FindOne (FindOneRequest) returns (TerminalResponse);
+  rpc FindAll (Empty) returns (TerminalListResponse);
+  rpc Update (UpdateTerminalRequest) returns (TerminalResponse);
+}
+
+message Empty {}
+
+message FindOneRequest {
+  string id = 1;
+}
+
+message UpdateTerminalRequest {
+  string id = 1;
+  optional bool isActive = 2;
+  optional bool supportsOnline = 3;
+  optional string model = 4;
+}
+
+message TerminalResponse {
+  string id = 1;
+  string serialNumber = 2;
+  string model = 3;
+  bool isActive = 4;
+  bool supportsOnline = 5;
+}
+
+message TerminalListResponse {
+  repeated TerminalResponse terminals = 1;
+}

package/proto/transaction.proto

@@ -0,0 +1,95 @@
+syntax = "proto3";
+
+package transaction;
+
+service TransactionService {
+  rpc Create (CreateTransactionDto) returns (Transaction) {}
+  rpc FindAll (FindTransactionsDto) returns (TransactionsResponse) {}
+  rpc Search (SearchTransactionsDto) returns (TransactionsResult) {}
+  rpc FindOne (FindOneTransactionDto) returns (Transaction) {}
+  rpc GetStats (GetStatsRequest) returns (StatsResponse) {}
+  rpc Update (UpdateTransactionDto) returns (Transaction) {}
+  rpc Remove (FindOneTransactionDto) returns (DeleteResponse) {}
+}
+
+message Transaction {
+  string id = 1;
+  string externalId = 2;
+  string cardId = 3;
+  double amount = 4;
+  string currency = 5;
+  string type = 6;
+  string status = 7;
+  string description = 8;
+  string transactionDate = 9;
+  string createdAt = 10;
+  string processingMode = 11;
+  string source = 12;
+  string terminalTxId = 13;
+  string posId = 14;
+  string updatedAt = 15;
+}
+
+message CreateTransactionDto {
+  string cardId = 1;
+  double amount = 2;
+  string externalId = 3;
+  string currency = 4;
+  string description = 5;
+  string type = 6;
+  string status = 7;
+}
+
+message UpdateTransactionDto {
+  string id = 1;
+  string status = 2;
+  string metadata = 3;
+}
+
+message FindOneTransactionDto {
+  string id = 1;
+}
+
+message FindTransactionsDto {
+  string cardId = 1;
+  int32 skip = 2;
+  int32 take = 3;
+  int32 year = 4;
+  int32 month = 5;
+  string status = 6;
+  string processingMode = 7;
+}
+
+message SearchTransactionsDto {
+  repeated string cardIds = 1;
+  string clientId = 2;
+  int32 skip = 3;
+  int32 take = 4;
+  string orderBy = 5;
+}
+
+message TransactionsResponse {
+  repeated Transaction transactions = 1;
+  int32 total = 2;
+}
+
+message TransactionsResult {
+  repeated Transaction items = 1;
+  int32 count = 2;
+}
+
+message GetStatsRequest {
+  optional string cardId = 1;
+}
+
+message StatsResponse {
+  int32 total = 1;
+  int32 success = 2;
+  int32 failed = 3;
+  int32 processing = 4;
+  double totalAmount = 5;
+}
+
+message DeleteResponse {
+  bool success = 1;
+}