/*
 * Copyright © 2025 Hexastack. All rights reserved.
 *
 * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
 * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
 * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
 */

import { Readable, Stream } from 'stream';

/**
 * Defines the types of createdBys for an attachment,
 * indicating whether the file belongs to a User or a Subscriber.
 */
export enum AttachmentCreatedByRef {
  User = 'User',
  Subscriber = 'Subscriber',
}

/**
 * Defines the various resource references in which an attachment can exist.
 * These resource references influence how the attachment is uploaded, stored, and accessed:
 */
export enum AttachmentResourceRef {
  SettingAttachment = 'Setting', // Attachments related to app settings, restricted to users with specific permissions.
  UserAvatar = 'User', // Avatar files for users, only the current user can upload, accessible to those with appropriate permissions.
  SubscriberAvatar = 'Subscriber', // Avatar files for subscribers, uploaded programmatically, accessible to authorized users.
  BlockAttachment = 'Block', // Files sent by the bot, public or private based on the channel and user authentication.
  ContentAttachment = 'Content', // Files in the knowledge base, usually public but could vary based on specific needs.
  MessageAttachment = 'Message', // Files sent or received via messages, uploaded programmatically, accessible to users with inbox permissions.;
}

export enum AttachmentAccess {
  Public = 'public',
  Private = 'private',
}

export class AttachmentFile {
  /**
   * File original file name
   */
  file: Buffer | Stream | Readable | Express.Multer.File;

  /**
   * File original file name
   */
  name?: string;

  /**
   * File size in bytes
   */
  size: number;

  /**
   * File MIME type
   */
  type: string;
}