game-analysis-types/dist/types/queue.d.ts

Common TypeScript types and utilities for game analysis tools.

/**
 * Enum representing the possible statuses of a queue entry.
 */
export type QueueStatus = 'queued' | 'processing' | 'complete' | 'error' | 'approved' | 'published' | 'failed';
/**
 * Interface representing a review audit entry.
 */
export interface ReviewAuditEntry {
    /**
     * The action taken by the reviewer (approve, reject, or flag).
     */
    action: 'approve' | 'reject' | 'flag';
    /**
     * The reviewer's username.
     */
    reviewer: string;
    /**
     * An optional comment left by the reviewer.
     */
    comment?: string;
    /**
     * The date the review was performed.
     */
    date: string;
}
/**
 * Interface representing a queue entry.
 */
export interface QueueEntry {
    /**
     * Unique identifier for the queue entry.
     */
    id: string;
    /**
     * The file path of the queue entry.
     */
    filePath: string;
    /**
     * The original name of the file.
     */
    originalName: string;
    /**
     * An optional title for the queue entry.
     */
    title?: string;
    /**
     * An optional list of tags for the queue entry.
     */
    tags?: string[];
    /**
     * An optional author for the queue entry.
     */
    author?: string;
    /**
     * An optional source for the queue entry.
     */
    source?: string;
    /**
     * An optional list of actions for the queue entry.
     */
    actions?: string[];
    /**
     * The current status of the queue entry.
     */
    status: QueueStatus;
    /**
     * The date the queue entry was created (can be a string or Date object).
     */
    createdAt: string | Date;
    /**
     * An optional result for the queue entry.
     */
    result?: any;
    /**
     * An optional list of logs for the queue entry.
     */
    logs?: string[];
    /**
     * An optional transformation status for the queue entry.
     */
    transformationStatus?: 'needs_transformation' | 'pretransformed' | undefined;
    /**
     * An optional template for the queue entry.
     */
    template?: string | undefined;
    /**
     * An optional published status for the queue entry.
     */
    published?: boolean | undefined;
    /**
     * An optional library ID for the queue entry.
     */
    libraryId?: string | undefined;
    /**
     * An optional review status for the queue entry.
     */
    reviewStatus?: 'pending' | 'approved' | 'rejected' | 'flagged';
    /**
     * An optional reviewer for the queue entry.
     */
    reviewer?: string;
    /**
     * An optional review comment for the queue entry.
     */
    reviewComment?: string;
    /**
     * An optional list of review audit entries for the queue entry.
     */
    audit?: ReviewAuditEntry[];
}
//# sourceMappingURL=queue.d.ts.map