chore: standardize protocol

Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
2026-02-14 11:45:34 -05:00
parent 169b7b4c91
commit fefa0a0384
18 changed files with 3090 additions and 1239 deletions

View File

@@ -1,119 +1,161 @@
/**
* Message/Entity management service
* Entity management service
*/
import { transceivePost } from './transceive';
import type {
MessageListRequest,
MessageListResponse,
MessageDeltaRequest,
MessageDeltaResponse,
MessageExtantRequest,
MessageExtantResponse,
MessageFetchRequest,
MessageFetchResponse,
MessageSearchRequest,
MessageSearchResponse,
MessageSendRequest,
MessageSendResponse,
MessageCreateRequest,
MessageCreateResponse,
MessageUpdateRequest,
MessageUpdateResponse,
MessageDestroyRequest,
MessageDestroyResponse,
EntityListRequest,
EntityListResponse,
EntityFetchRequest,
EntityFetchResponse,
EntityExtantRequest,
EntityExtantResponse,
EntityCreateRequest,
EntityCreateResponse,
EntityUpdateRequest,
EntityUpdateResponse,
EntityDeleteRequest,
EntityDeleteResponse,
EntityDeltaRequest,
EntityDeltaResponse,
EntityTransmitRequest,
EntityTransmitResponse,
EntityInterface,
} from '../types/entity';
import { useIntegrationStore } from '@KTXC/stores/integrationStore';
import { EntityObject } from '../models';
/**
* Helper to create the right entity model class based on provider identifier
* Uses provider-specific factory if available, otherwise returns base EntityObject
*/
function createEntityObject(data: EntityInterface): EntityObject {
const integrationStore = useIntegrationStore();
const factoryItem = integrationStore.getItemById('mail_entity_factory', data.provider) as any;
const factory = factoryItem?.factory;
// Use provider factory if available, otherwise base class
return factory ? factory(data) : new EntityObject().fromJson(data);
}
export const entityService = {
/**
* List all available messages
* Retrieve list of entities, optionally filtered by source selector
*
* @param request - Message list request parameters
* @returns Promise with message list grouped by provider, service, and collection
* @param request - list request parameters
*
* @returns Promise with entity object list grouped by provider, service, collection, and entity identifier
*/
async list(request: MessageListRequest = {}): Promise<MessageListResponse> {
return await transceivePost<MessageListRequest, MessageListResponse>('entity.list', request);
async list(request: EntityListRequest = {}): Promise<Record<string, Record<string, Record<string, Record<string, EntityObject>>>>> {
const response = await transceivePost<EntityListRequest, EntityListResponse>('entity.list', request);
// Convert nested response to EntityObject instances
const providerList: Record<string, Record<string, Record<string, Record<string, EntityObject>>>> = {};
Object.entries(response).forEach(([providerId, providerServices]) => {
const serviceList: Record<string, Record<string, Record<string, EntityObject>>> = {};
Object.entries(providerServices).forEach(([serviceId, serviceCollections]) => {
const collectionList: Record<string, Record<string, EntityObject>> = {};
Object.entries(serviceCollections).forEach(([collectionId, collectionEntities]) => {
const entityList: Record<string, EntityObject> = {};
Object.entries(collectionEntities).forEach(([entityId, entityData]) => {
entityList[entityId] = createEntityObject(entityData);
});
collectionList[collectionId] = entityList;
});
serviceList[serviceId] = collectionList;
});
providerList[providerId] = serviceList;
});
return providerList;
},
/**
* Get delta changes for messages
* Retrieve a specific entity by provider and identifier
*
* @param request - fetch request parameters
*
* @returns Promise with entity objects keyed by identifier
*/
async fetch(request: EntityFetchRequest): Promise<Record<string, EntityObject>> {
const response = await transceivePost<EntityFetchRequest, EntityFetchResponse>('entity.fetch', request);
// Convert response to EntityObject instances
const list: Record<string, EntityObject> = {};
Object.entries(response).forEach(([identifier, entityData]) => {
list[identifier] = createEntityObject(entityData);
});
return list;
},
/**
* Retrieve entity availability status for a given source selector
*
* @param request - extant request parameters
*
* @returns Promise with entity availability status
*/
async extant(request: EntityExtantRequest): Promise<EntityExtantResponse> {
return await transceivePost<EntityExtantRequest, EntityExtantResponse>('entity.extant', request);
},
/**
* Create a new entity
*
* @param request - create request parameters
*
* @returns Promise with created entity object
*/
async create(request: EntityCreateRequest): Promise<EntityObject> {
const response = await transceivePost<EntityCreateRequest, EntityCreateResponse>('entity.create', request);
return createEntityObject(response);
},
/**
* Update an existing entity
*
* @param request - update request parameters
*
* @returns Promise with updated entity object
*/
async update(request: EntityUpdateRequest): Promise<EntityObject> {
const response = await transceivePost<EntityUpdateRequest, EntityUpdateResponse>('entity.update', request);
return createEntityObject(response);
},
/**
* Delete an entity
*
* @param request - delete request parameters
*
* @returns Promise with deletion result
*/
async delete(request: EntityDeleteRequest): Promise<EntityDeleteResponse> {
return await transceivePost<EntityDeleteRequest, EntityDeleteResponse>('entity.delete', request);
},
/**
* Retrieve delta changes for entities
*
* @param request - delta request parameters
*
* @param request - Message delta request with source selector
* @returns Promise with delta changes (created, modified, deleted)
*/
async delta(request: MessageDeltaRequest): Promise<MessageDeltaResponse> {
return await transceivePost('entity.delta', request);
async delta(request: EntityDeltaRequest): Promise<EntityDeltaResponse> {
return await transceivePost<EntityDeltaRequest, EntityDeltaResponse>('entity.delta', request);
},
/**
* Check which messages exist/are available
* Send an entity
*
* @param request - Message extant request with source selector
* @returns Promise with message availability status
*/
async extant(request: MessageExtantRequest): Promise<MessageExtantResponse> {
return await transceivePost('entity.extant', request);
},
/**
* Fetch specific messages
* @param request - transmit request parameters
*
* @param request - Message fetch request
* @returns Promise with message details
* @returns Promise with transmission result
*/
async fetch(request: MessageFetchRequest): Promise<MessageFetchResponse> {
return await transceivePost('entity.fetch', request);
},
/**
* Search messages
*
* @param request - Message search request
* @returns Promise with search results
*/
async search(request: MessageSearchRequest): Promise<MessageSearchResponse> {
return await transceivePost('entity.search', request);
},
/**
* Send a message
*
* @param request - Message send request
* @returns Promise with send result
*/
async send(request: MessageSendRequest): Promise<MessageSendResponse> {
return await transceivePost('entity.send', request);
},
/**
* Create a new message (draft)
*
* @param request - Message create request
* @returns Promise with created message details
*/
async create(request: MessageCreateRequest): Promise<MessageCreateResponse> {
return await transceivePost('entity.create', request);
},
/**
* Update an existing message (flags, labels, etc.)
*
* @param request - Message update request
* @returns Promise with update result
*/
async update(request: MessageUpdateRequest): Promise<MessageUpdateResponse> {
return await transceivePost('entity.update', request);
},
/**
* Delete/destroy a message
*
* @param request - Message destroy request
* @returns Promise with destroy result
*/
async destroy(request: MessageDestroyRequest): Promise<MessageDestroyResponse> {
return await transceivePost('entity.destroy', request);
async transmit(request: EntityTransmitRequest): Promise<EntityTransmitResponse> {
return await transceivePost<EntityTransmitRequest, EntityTransmitResponse>('entity.transmit', request);
},
};