forest_admin_rails 1.14.4 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece9ed1610ed31954b9adf0d07cecee4916b967d81da845408858e6d220df42f
-  data.tar.gz: 592102d9920717205aa9a6e9122de803d810482f363e9cdcf98d332184829186
+  metadata.gz: c5da59d5de057e0448e039fad113b556685db5b25ab4c611a3161f10e198077c
+  data.tar.gz: 29650aa77eebb0ba5e9fab0088607d86b5cbae9767b40804d249b025cdc9ab0e
 SHA512:
-  metadata.gz: 548129e19e2869cad5cc129225cb81ff0832149c7a1cc62450a3c23c1a59309e6293e5868f002a62c903616d9ba2c390e39a0bbb567b41c7092dfa66984381d2
-  data.tar.gz: 2481e7471445fad8b2c7c398090c28edda9e2af95270ccc4f02ab44fe0ad7da6d70fc2cb7a58b2b8f2788d839a566a547bb622b862aa14e8d01b135c7cd32c23
+  metadata.gz: f3e26d15e79243635611ca7323ecdf4aa74a8b8c9b9bb7c866d3e1719ba6fb3f19f888a801f91a8104dbad53ad6634e5d26c3e0cc4ee244c5c6aac96543faa07
+  data.tar.gz: 6d67f9f0b01fc8929cb5d62ed604e6d776cd51f0d24f6636e461d0264ee39fda4e8d30756bd654260fa931977868c28ecb890269357e98829ce82f03f1909f4d

data/lib/forest_admin/types.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+# Ensure dependencies are fully loaded before referencing their constants
+require 'forest_admin_datasource_toolkit'
+require 'forest_admin_datasource_customizer'
+require 'forest_admin_agent'
+
+# ForestAdmin::Types provides a convenient way to access commonly-used classes
+# from ForestAdmin packages without requiring multiple includes.
+#
+# Usage:
+#   include ForestAdmin::Types
+#
+#   # Now you can use short class names:
+#   ConditionTreeLeaf.new('status', Operators::EQUAL, 'active')
+#   Filter.new(condition_tree: tree)
+#   Aggregation.new(operation: 'Count', field: 'id')
+#
+#   # In action blocks, result_builder is an ActionResultBuilder:
+#   result_builder.success(message: 'Done!')
+#   result_builder.file(content: data, name: 'export.csv')
+#
+#   # In chart blocks, result_builder is a ChartResultBuilder:
+#   result_builder.value(42)
+#   result_builder.distribution({ 'Active' => 10, 'Inactive' => 5 })
+#
+#   # Factory classes for building complex objects:
+#   tree = ConditionTreeFactory.from_plain_object({ field: 'status', operator: 'equal', value: 'active' })
+#   filter = ConditionTreeFactory.match_ids(collection, [1, 2, 3])
+#   combined = ConditionTreeFactory.intersect([tree1, tree2])
+#   projection = ProjectionFactory.all(collection)
+#   sort = SortFactory.by_primary_keys(collection)
+#
+#   # Exception handling in hooks and actions:
+#   raise ValidationError.new('Invalid input') if invalid?
+#   raise ForbiddenError.new('Access denied') unless authorized?
+#   raise UnprocessableError.new('Cannot process request')
+#
+#   # Context classes for different handlers:
+#   # - ChartContext: context.get_record(['field1', 'field2'])
+#   # - HookContext: context.raise_validation_error('Error message')
+#
+module ForestAdmin
+  module Types
+    # ============================================
+    # Query Components
+    # ============================================
+
+    # Filter - used to filter records in queries
+    Filter = ForestAdminDatasourceToolkit::Components::Query::Filter
+
+    # Aggregation - used for aggregate operations (Count, Sum, Avg, etc.)
+    Aggregation = ForestAdminDatasourceToolkit::Components::Query::Aggregation
+
+    # Projection - specifies which fields to retrieve
+    Projection = ForestAdminDatasourceToolkit::Components::Query::Projection
+
+    # Page - pagination parameters
+    Page = ForestAdminDatasourceToolkit::Components::Query::Page
+
+    # Sort - sorting parameters
+    Sort = ForestAdminDatasourceToolkit::Components::Query::Sort
+
+    # ============================================
+    # Condition Tree
+    # ============================================
+
+    # ConditionTreeLeaf - a single condition (field, operator, value)
+    ConditionTreeLeaf = ForestAdminDatasourceToolkit::Components::Query::ConditionTree::Nodes::ConditionTreeLeaf
+
+    # ConditionTreeBranch - combines multiple conditions with And/Or
+    ConditionTreeBranch = ForestAdminDatasourceToolkit::Components::Query::ConditionTree::Nodes::ConditionTreeBranch
+
+    # Operators - all available operators (EQUAL, GREATER_THAN, CONTAINS, etc.)
+    Operators = ForestAdminDatasourceToolkit::Components::Query::ConditionTree::Operators
+
+    # ============================================
+    # Action Types
+    # ============================================
+
+    # FieldType - field types for action forms (STRING, NUMBER, BOOLEAN, etc.)
+    FieldType = ForestAdminDatasourceCustomizer::Decorators::Action::Types::FieldType
+
+    # ActionScope - action scopes (SINGLE, BULK, GLOBAL)
+    ActionScope = ForestAdminDatasourceCustomizer::Decorators::Action::Types::ActionScope
+
+    # BaseAction - base class for defining actions
+    BaseAction = ForestAdminDatasourceCustomizer::Decorators::Action::BaseAction
+
+    # ============================================
+    # Action Contexts
+    # ============================================
+
+    # ActionContext - execution context for Bulk/Global actions
+    ActionContext = ForestAdminDatasourceCustomizer::Decorators::Action::Context::ActionContext
+
+    # ActionContextSingle - execution context for Single actions
+    ActionContextSingle = ForestAdminDatasourceCustomizer::Decorators::Action::Context::ActionContextSingle
+
+    # ActionResultBuilder - builder for action results (success, error, file, webhook)
+    ActionResultBuilder = ForestAdminDatasourceCustomizer::Decorators::Action::ResultBuilder
+
+    # ============================================
+    # Charts
+    # ============================================
+
+    # ChartResultBuilder - builder for chart results (value, distribution, time_based, etc.)
+    ChartResultBuilder = ForestAdminDatasourceCustomizer::Decorators::Chart::ResultBuilder
+
+    # ============================================
+    # Computed Fields
+    # ============================================
+
+    # ComputedDefinition - defines computed/virtual fields
+    ComputedDefinition = ForestAdminDatasourceCustomizer::Decorators::Computed::ComputedDefinition
+
+    # ============================================
+    # User/Caller Information
+    # ============================================
+
+    # Caller - represents the user making the request (email, timezone, team, etc.)
+    Caller = ForestAdminDatasourceToolkit::Components::Caller
+
+    # ============================================
+    # Plugins
+    # ============================================
+
+    # Plugin - base class for creating custom plugins
+    Plugin = ForestAdminDatasourceCustomizer::Plugins::Plugin
+
+    # ============================================
+    # Additional Context Classes
+    # ============================================
+
+    # ChartContext - execution context for chart handlers
+    # Methods: get_record(fields), record_id, composite_record_id
+    ChartContext = ForestAdminDatasourceCustomizer::Decorators::Chart::ChartContext
+
+    # HookContext - execution context for hook handlers
+    # Methods: raise_validation_error, raise_forbidden_error, raise_error
+    HookContext = ForestAdminDatasourceCustomizer::Decorators::Hook::Context::HookContext
+
+    # ============================================
+    # Exception Classes
+    # ============================================
+
+    # BusinessError - base class for all business errors
+    BusinessError = ForestAdminAgent::Http::Exceptions::BusinessError
+
+    # Specific error types for better error handling
+    ValidationError = ForestAdminAgent::Http::Exceptions::ValidationError
+    ForbiddenError = ForestAdminAgent::Http::Exceptions::ForbiddenError
+    UnauthorizedError = ForestAdminAgent::Http::Exceptions::UnauthorizedError
+    NotFoundError = ForestAdminAgent::Http::Exceptions::NotFoundError
+    UnprocessableError = ForestAdminAgent::Http::Exceptions::UnprocessableError
+    BadRequestError = ForestAdminAgent::Http::Exceptions::BadRequestError
+
+    # ============================================
+    # Factory Classes
+    # ============================================
+
+    # ConditionTreeFactory - factory methods for creating condition trees
+    # Methods: from_plain_object, match_ids, match_records, intersect, union, match_none
+    ConditionTreeFactory = ForestAdminDatasourceToolkit::Components::Query::ConditionTree::ConditionTreeFactory
+
+    # FilterFactory - factory methods for creating filters
+    # Methods: from_plain_object, make_foreign_filter, make_through_filter
+    FilterFactory = ForestAdminDatasourceToolkit::Components::Query::FilterFactory
+
+    # ProjectionFactory - factory methods for creating projections
+    # Methods: all(collection)
+    ProjectionFactory = ForestAdminDatasourceToolkit::Components::Query::ProjectionFactory
+
+    # SortFactory - factory methods for creating sort clauses
+    # Methods: by_primary_keys(collection)
+    SortFactory = ForestAdminDatasourceToolkit::Components::Query::SortUtils::SortFactory
+
+    # ============================================
+    # Module inclusion support
+    # ============================================
+
+    def self.included(base)
+      # When included, define constants on the including class/module
+      # This allows using `include ForestAdmin::Types` and then referencing
+      # the types directly without the ForestAdmin::Types prefix
+      constants.each do |const_name|
+        base.const_set(const_name, const_get(const_name)) unless base.const_defined?(const_name)
+      end
+    end
+  end
+end

data/lib/forest_admin_rails/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminRails
-  VERSION = "1.14.4"
+  VERSION = "1.15.0"
 end

data/lib/forest_admin_rails.rb

@@ -4,6 +4,7 @@ require 'forest_admin_rails/engine'
 require 'zeitwerk'
 require 'rails/railtie'
 require 'forest_admin_agent'
+require_relative 'forest_admin/types'
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/generators")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_rails
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.15.0
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-25 00:00:00.000000000 Z
+date: 2025-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -140,6 +140,7 @@ files:
 - config/initializers/forest_admin_error_subscriber.rb
 - config/initializers/forest_admin_route_cache.rb
 - config/routes.rb
+- lib/forest_admin/types.rb
 - lib/forest_admin_rails.rb
 - lib/forest_admin_rails/engine.rb
 - lib/forest_admin_rails/version.rb