phoenix_kit

1.7.126

1.7.208 1.7.207 1.7.206 1.7.205 1.7.204 1.7.203 1.7.202 1.7.201 1.7.200 1.7.199 1.7.198 1.7.197 1.7.196 1.7.194 1.7.193 1.7.192 1.7.191 1.7.190 1.7.189 1.7.187 1.7.186 1.7.185 1.7.184 1.7.183 1.7.182 1.7.181 1.7.180 1.7.179 1.7.178 1.7.177 1.7.176 1.7.175 1.7.174 1.7.173 1.7.172 1.7.171 1.7.170 1.7.169 1.7.168 1.7.167 1.7.166 1.7.165 1.7.164 1.7.162 1.7.161 1.7.160 1.7.159 1.7.157 1.7.156 1.7.155 1.7.154 1.7.153 1.7.152 1.7.151 1.7.150 1.7.149 1.7.146 1.7.145 1.7.144 1.7.143 1.7.138 1.7.133 1.7.132 1.7.131 1.7.130 1.7.128 1.7.126 1.7.125 1.7.121 1.7.120 1.7.119 1.7.118 1.7.117 1.7.116 1.7.115 1.7.114 1.7.113 1.7.112 1.7.111 1.7.110 1.7.109 1.7.108 1.7.107 1.7.106 1.7.105 1.7.104 1.7.103 1.7.102 1.7.101 1.7.100 1.7.99 1.7.98 1.7.97 1.7.96 1.7.95 1.7.94 1.7.93 1.7.92 1.7.91 1.7.90 1.7.89 1.7.88 1.7.87 1.7.86 1.7.85 1.7.84 1.7.83 1.7.82 1.7.81 1.7.80 1.7.79 1.7.78 1.7.77 1.7.76 1.7.75 1.7.74 1.7.71 1.7.70 1.7.69 1.7.66 1.7.65 1.7.64 1.7.63 1.7.62 1.7.61 1.7.59 1.7.58 1.7.57 1.7.56 1.7.55 1.7.54 1.7.53 1.7.52 1.7.51 1.7.49 1.7.44 1.7.43 1.7.42 1.7.41 1.7.39 1.7.38 1.7.37 1.7.36 1.7.34 1.7.33 1.7.31 1.7.30 1.7.29 1.7.28 1.7.27 1.7.26 1.7.25 1.7.24 1.7.23 1.7.22 1.7.21 1.7.20 1.7.19 1.7.18 1.7.17 1.7.16 1.7.15 1.7.14 1.7.13 1.7.12 1.7.11 1.7.10 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.20 1.6.19 1.6.18 1.6.17 1.6.16 1.6.15 1.6.14 1.6.13 1.6.12 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.5.2 1.5.1 1.5.0 1.4.9 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.10 1.2.9 1.2.8 1.2.7 1.2.5 1.2.4 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0

A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more

HexDocs

Current section

Files

Jump to

Readme 222 Versions 45 Dependencies Dependants Files Activity

phoenix_kit lib modules storage schemas file_instance.ex

Raw

lib/modules/storage/schemas/file_instance.ex

defmodule PhoenixKit.Modules.Storage.FileInstance do
  @moduledoc """
  Schema for file variants (thumbnails, resizes, video qualities).

  Each file can have multiple instances representing different versions:
  - **original** - The unchanged uploaded file
  - **thumbnail** - Small preview (150x150)
  - **small** - Small variant (300x300)
  - **medium** - Medium variant (800x600)
  - **large** - Large variant (1920x1080)
  - **360p** - Video quality variant (640x360)
  - **720p** - Video quality variant (1280x720)
  - **1080p** - Video quality variant (1920x1080)
  - **video_thumbnail** - Thumbnail extracted from video (640x360)

  All instances are stored next to the original file in the same directory.

  ## Processing Status

  - `pending` - Instance not yet processed
  - `processing` - Currently being generated
  - `completed` - Successfully generated
  - `failed` - Generation failed

  ## Fields

  - `variant_name` - Name of the variant (original, thumbnail, medium, etc.)
  - `file_name` - System filename (uuid_v7-variant.ext)
  - `mime_type` - MIME type of this variant
  - `ext` - File extension
  - `checksum` - Hash for integrity verification
  - `size` - Variant file size in bytes
  - `width` - Width in pixels (nullable)
  - `height` - Height in pixels (nullable)
  - `processing_status` - Current processing state
  - `file_uuid` - Parent file reference

  ## Examples

      # Original instance
      %FileInstance{
        variant_name: "original",
        file_name: "018e3c4a-9f6b-7890-original.jpg",
        mime_type: "image/jpeg",
        ext: "jpg",
        checksum: "abc123...",
        size: 524_288,
        width: 2000,
        height: 2000,
        processing_status: "completed",
        file_uuid: "018e3c4a-9f6b-7890-abcd-ef1234567890"
      }

      # Thumbnail instance
      %FileInstance{
        variant_name: "thumbnail",
        file_name: "018e3c4a-9f6b-7890-thumbnail.jpg",
        mime_type: "image/jpeg",
        ext: "jpg",
        checksum: "def456...",
        size: 8_192,  # 8 KB
        width: 150,
        height: 150,
        processing_status: "completed",
        file_uuid: "018e3c4a-9f6b-7890-abcd-ef1234567890"
      }

      # Video quality variant
      %FileInstance{
        variant_name: "720p",
        file_name: "018e3c4a-9f6b-7890-720p.mp4",
        mime_type: "video/mp4",
        ext: "mp4",
        size: 5_242_880,  # 5 MB
        width: 1280,
        height: 720,
        processing_status: "processing"
      }
  """
  use Ecto.Schema
  import Ecto.Changeset

  @primary_key {:uuid, UUIDv7, autogenerate: true}
  @foreign_key_type UUIDv7

  @type t :: %__MODULE__{
          uuid: UUIDv7.t() | nil,
          variant_name: String.t(),
          file_name: String.t(),
          mime_type: String.t(),
          ext: String.t(),
          checksum: String.t(),
          size: integer(),
          width: integer() | nil,
          height: integer() | nil,
          processing_status: String.t(),
          file_uuid: UUIDv7.t() | nil,
          file: PhoenixKit.Modules.Storage.File.t() | Ecto.Association.NotLoaded.t(),
          locations:
            [PhoenixKit.Modules.Storage.FileLocation.t()] | Ecto.Association.NotLoaded.t(),
          inserted_at: DateTime.t() | nil,
          updated_at: DateTime.t() | nil
        }

  schema "phoenix_kit_file_instances" do
    field :variant_name, :string
    field :file_name, :string
    field :mime_type, :string
    field :ext, :string
    field :checksum, :string
    field :size, :integer
    field :width, :integer
    field :height, :integer
    field :processing_status, :string, default: "pending"

    belongs_to :file, PhoenixKit.Modules.Storage.File, foreign_key: :file_uuid, references: :uuid
    has_many :locations, PhoenixKit.Modules.Storage.FileLocation, foreign_key: :file_instance_uuid

    timestamps(type: :utc_datetime)
  end

  @doc """
  Changeset for creating or updating a file instance.

  ## Required Fields

  - `variant_name`
  - `file_name`
  - `mime_type`
  - `ext`
  - `checksum`
  - `size`
  - `file_uuid`

  ## Validation Rules

  - Processing status must be valid (pending, processing, completed, failed)
  - Size must be positive
  - Width/height must be positive (if provided)
  - Unique variant_name per file
  """
  def changeset(instance, attrs) do
    instance
    |> cast(attrs, [
      :variant_name,
      :file_name,
      :mime_type,
      :ext,
      :checksum,
      :size,
      :width,
      :height,
      :processing_status,
      :file_uuid
    ])
    |> validate_required([
      :variant_name,
      :file_name,
      :mime_type,
      :ext,
      :checksum,
      :size,
      :file_uuid
    ])
    |> validate_inclusion(:processing_status, ["pending", "processing", "completed", "failed"])
    |> validate_number(:size, greater_than: 0)
    |> validate_number(:width, greater_than: 0)
    |> validate_number(:height, greater_than: 0)
    |> unique_constraint([:file_uuid, :variant_name],
      name: :phoenix_kit_file_instances_file_uuid_variant_name_index
    )
    |> foreign_key_constraint(:file_uuid)
  end

  @doc """
  Returns whether this is the original file instance.
  """
  def original?(%__MODULE__{variant_name: "original"}), do: true
  def original?(_), do: false

  @doc """
  Returns whether this instance has been successfully processed.
  """
  def completed?(%__MODULE__{processing_status: "completed"}), do: true
  def completed?(_), do: false

  @doc """
  Returns whether this instance failed processing.
  """
  def failed?(%__MODULE__{processing_status: "failed"}), do: true
  def failed?(_), do: false

  @doc """
  Returns whether this instance is currently being processed.
  """
  def processing?(%__MODULE__{processing_status: "processing"}), do: true
  def processing?(_), do: false

  @doc """
  Returns whether this instance is pending processing.
  """
  def pending?(%__MODULE__{processing_status: "pending"}), do: true
  def pending?(_), do: false
end

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT