habarico 7.2.0.pre.beta.5

data/lib/habarico/schema/action/global_resource_action_schema.rb

@@ -0,0 +1,29 @@
+module Habarico
+  class GlobalResourceActionSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the action used for coupling with the action descriptor
+    string_attr :name
+
+    # Type of the action.
+    # `view` - opens a new view as redirect or dialog
+    # `link` - opens an external link
+    # `resource` - performs an action on the resource (like delete, update, etc.
+    string_attr :type
+    # Deliberately a subset of Types::ACTION_TYPE - the global schema only advertises the action
+    # types that can be rendered without a resource context.
+    enum_attr :type, %i[view link resource]
+
+    # Flag indicating if the action uses primary key or not
+    boolean_attr :is_detail
+
+    # Flag indicating if the action should be shown in detail view
+    boolean_attr :show_in_detail
+
+    # Flag indicating if the action should be shown in list view
+    boolean_attr :show_in_list
+
+  end
+end

data/lib/habarico/schema/action/link_action_parameters.rb

@@ -0,0 +1,15 @@
+module Habarico
+  class LinkActionParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # External URL for the action link
+    string_attr :url
+
+    # Target for opening the link, either in the same tab or a new tab
+    string_attr :target
+    enum_attr :target, Types::LINK_TARGET_TYPE
+
+  end
+end

data/lib/habarico/schema/action/resource_action_endpoint_parameters.rb

@@ -0,0 +1,24 @@
+module Habarico
+  class ResourceActionEndpointParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # API path for the requested endpoint
+    string_attr :path
+
+    # HTTP method for the requested endpoint
+    string_attr :method
+    enum_attr :method, Types::REQUEST_METHOD_TYPE
+
+    # Reference to another resource, if applicable
+    string_attr :reference
+
+    # Name of the controller action associated with the endpoint, if applicable
+    string_attr :action_name
+
+    # Primary key of the requested record, if applicable
+    string_attr :record_pk
+
+  end
+end

data/lib/habarico/schema/action/resource_action_parameters.rb

@@ -0,0 +1,17 @@
+module Habarico
+  class ResourceActionParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Flag indicating if the resource action is a background task
+    boolean_attr :is_background
+
+    # Additional data which will be sent to the action
+    any_attr :data
+
+    # Definition of the endpoint
+    has_one_attr :endpoint, 'Habarico::ResourceActionEndpointParameters'
+
+  end
+end

data/lib/habarico/schema/action/resource_action_schema.rb

@@ -0,0 +1,14 @@
+module Habarico
+  class ResourceActionSchema < ActionSchema
+
+    # Name of the action used for coupling with the action descriptor
+    string_attr :name
+
+    # Flag indicating if the action should be shown in detail view
+    boolean_attr :show_in_detail
+
+    # Flag indicating if the action should be shown in list view
+    boolean_attr :show_in_list
+
+  end
+end

data/lib/habarico/schema/action/save_action_parameters.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class SaveActionParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Data that will be added to the object before saving
+    any_attr :data
+
+  end
+end

data/lib/habarico/schema/action/upload_images_action_parameters.rb

@@ -0,0 +1,23 @@
+module Habarico
+  class UploadImagesActionParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Resource where images will be created. When set, uploads to this resource
+    # instead of the current resource context.
+    string_attr :reference
+
+    # Field name on the image model linking to the parent record.
+    # When set together with reference, the current record's ID is used as the target value.
+    string_attr :target
+
+    # Array of accepted file extensions (e.g. [".png", ".jpg"]).
+    # When not set, the frontend uses its own default (.png,.jpg,.jpeg,.bmp,.gif).
+    any_attr :accept
+
+    # Field name on the target model that holds the uploaded file. Required by the
+    # frontend to know which attribute to set on the record it creates for each upload.
+    string_attr :image_field
+
+  end
+end

data/lib/habarico/schema/action/view_action_endpoint_parameters.rb

@@ -0,0 +1,16 @@
+module Habarico
+  class ViewActionEndpointParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Reference to another resource, if applicable
+    string_attr :reference
+
+    # Name of the controller action associated with the endpoint, if applicable
+    string_attr :action_name
+
+    # Primary key of the requested record, if applicable
+    string_attr :record_pk
+
+  end
+end

data/lib/habarico/schema/action/view_action_parameters.rb

@@ -0,0 +1,27 @@
+module Habarico
+  class ViewActionParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the view to be rendered, used for coupling with view schema
+    string_attr :name
+
+    # Mode in which to display the action view: redirect to a standalone page, dialog, or side panel
+    string_attr :mode
+    enum_attr :mode, Types::VIEW_MODE_TYPE
+
+    # Width of the dialog, only used when mode is dialog (MUI breakpoint or CSS width value)
+    string_attr :dialog_width
+
+    # Definition of the endpoint
+    has_one_attr :endpoint, 'Habarico::ViewActionEndpointParameters'
+
+    # Additional parameters to be passed to the view
+    has_many_attr :parameters, 'String', underlying_type: :hash
+
+    # Keep linked parent in the URL when navigating to the linked resource
+    boolean_attr :keep_linked_parent
+
+  end
+end

data/lib/habarico/schema/endpoint/ai_field_options.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class AiFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # List of field names used as sources for AI generation
+    has_many_attr :source_fields, 'String'
+
+  end
+end

data/lib/habarico/schema/endpoint/box_options.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class BoxOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Options for dynamic rendering of the box (conditional show/required)
+    has_one_attr :dynamic_render, 'Habarico::DynamicRenderOptions'
+
+  end
+end

data/lib/habarico/schema/endpoint/choices_field_options.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class ChoicesFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Key used to look up icons for the field value
+    string_attr :icons_key
+
+  end
+end

data/lib/habarico/schema/endpoint/dynamic_render_options.rb

@@ -0,0 +1,14 @@
+module Habarico
+  class DynamicRenderOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # The field will be shown if query is true
+    string_attr :show_query
+
+    # The field will be required if query is true
+    string_attr :required_query
+
+  end
+end

data/lib/habarico/schema/endpoint/endpoints_schema.rb

@@ -0,0 +1,22 @@
+module Habarico
+  class EndpointsSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Endpoint definition for GET method
+    has_one_attr :get, 'Habarico::MethodSchema'
+
+    # Endpoint definition for POST method
+    has_one_attr :post, 'Habarico::MethodSchema'
+
+    # Endpoint definition for PATCH method
+    has_one_attr :patch, 'Habarico::MethodSchema'
+
+    # Endpoint definition for PUT method
+    has_one_attr :put, 'Habarico::MethodSchema'
+
+    # Endpoint definition for DELETE method
+    has_one_attr :delete, 'Habarico::MethodSchema'
+
+  end
+end

data/lib/habarico/schema/endpoint/enum_type.rb

@@ -0,0 +1,21 @@
+module Habarico
+  class EnumType
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Value of the enum item
+    string_attr :value
+
+    # Human-readable label of the enum item
+    string_attr :label
+
+    # Color of the enum item. Uses standard MUI color types
+    string_attr :color
+    enum_attr :color, Types::COLOR_TYPE
+
+    # Icon of the enum item
+    string_attr :icon
+
+  end
+end

data/lib/habarico/schema/endpoint/field_options.rb

@@ -0,0 +1,56 @@
+module Habarico
+  class FieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Prefix to add before the field value
+    string_attr :prefix
+
+    # Postfix to add after the field value
+    string_attr :postfix
+
+    # Alignment of the field value
+    string_attr :text_align
+    enum_attr :text_align, Types::TEXT_ALIGN_TYPE
+
+    # Where the field's link opens when the value is clicked. Stored without the leading underscore
+    # ('blank', not '_blank') - the frontend prepends it when rendering the anchor.
+    # Unrelated to a box's 'target', which names the nested attribute or foreign key.
+    string_attr :target
+    enum_attr :target, Types::LINK_TARGET_TYPE
+
+    # Options for formatting the number values
+    has_one_attr :number, 'Habarico::NumberFieldOptions'
+
+    # Options for dynamic rendering of the field value
+    has_one_attr :dynamic_render, 'Habarico::DynamicRenderOptions'
+
+    # Options for relation fields (how the related resource is displayed and linked)
+    has_one_attr :relation, 'Habarico::RelationFieldOptions'
+
+    # Options for the phone number field
+    has_one_attr :phone, 'Habarico::PhoneFieldOptions'
+
+    # Options for choices fields (icon lookup, etc.)
+    has_one_attr :choices, 'Habarico::ChoicesFieldOptions'
+
+    # Options for image fields (resizing, cropping)
+    has_one_attr :image, 'Habarico::ImageFieldOptions'
+
+    # Options for AI-generated fields
+    has_one_attr :ai, 'Habarico::AiFieldOptions'
+
+    # Largest file (bytes) the frontend accepts for this field, checked before the upload starts.
+    # Derived from a `file_attr`'s own `active_storage_validations` size declaration (HAB-966); see
+    # `Habarico::FileValidations`. `habarico_enterprise.uploads` additionally folds in its
+    # project-wide `Config.max_upload_size` ceiling for a field a chunked-upload provider serves.
+    integer_attr :max_size
+
+    # File types the frontend accepts for this field, checked before the upload starts. Derived
+    # from a `file_attr`'s own `active_storage_validations` content-type declaration (HAB-966); see
+    # `Habarico::FileValidations`.
+    has_many_attr :accept, 'String'
+
+  end
+end

data/lib/habarico/schema/endpoint/field_schema.rb

@@ -0,0 +1,65 @@
+module Habarico
+  class FieldSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+    include Habarico::ExtensibleEnum
+
+    # Name of the field in the data model, used for coupling with field descriptor
+    string_attr :name
+
+    # Data type of the field
+    string_attr :type
+    extensible_enum_attr :type, :FIELD_TYPE
+
+    # Format of the field, applied to specific data types such as string
+    string_attr :format
+    extensible_enum_attr :format, :FIELD_FORMAT_TYPE
+
+    # Human-readable label for the field
+    string_attr :label
+
+    # Short label for the field, used in compact displays
+    string_attr :short_label
+
+    # Human-readable help text for the field displayed usually under the field or as placeholder
+    string_attr :help_text
+
+    # Flag indicating if the field is read-only
+    boolean_attr :read_only
+
+    # Flag indicating if the field is write-only
+    boolean_attr :write_only
+
+    # Flag indicating if the field can be null
+    boolean_attr :nullable
+
+    # Flag indicating if the field is required
+    boolean_attr :required
+
+    # Default value for the field
+    any_attr :default_value
+
+    # Flag indicating if the field is sortable
+    boolean_attr :sortable
+
+    # Field name to use for sorting if different from the field name
+    string_attr :sort_by
+
+    # Reference to another resource
+    string_attr :reference
+
+    # Enumeration items for field with predefined choices, usually used with 'choices' format
+    has_many_attr :enum, 'Habarico::EnumType'
+
+    # Schema of items in case of 'array' type
+    has_one_attr :items, 'Habarico::FieldSchema'
+
+    # Schema of properties in case of 'object' type
+    has_many_attr :properties, 'Habarico::FieldSchema'
+
+    # Additional options for the value formating and display
+    has_one_attr :options, 'Habarico::FieldOptions'
+
+  end
+end

data/lib/habarico/schema/endpoint/filter_schema.rb

@@ -0,0 +1,44 @@
+module Habarico
+  class FilterSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+    include Habarico::ExtensibleEnum
+
+    # Name of the filter in API, used for coupling with filter descriptor
+    string_attr :name
+
+    # Data type of the filter field
+    string_attr :type
+    extensible_enum_attr :type, :FIELD_TYPE
+
+    # Format of the filter field, applied to specific data types such as string
+    string_attr :format
+    extensible_enum_attr :format, :FIELD_FORMAT_TYPE
+
+    # Human-readable label for the filter
+    string_attr :label
+
+    # Human-readable help text for the filter displayed usually under the field or as placeholder
+    string_attr :help_text
+
+    # Reference to another resource
+    string_attr :reference
+
+    # Enumeration items for field with predefined choices, usually used with 'choices' format
+    has_many_attr :enum, 'Habarico::EnumType'
+
+    # Schema of items in case of 'array' type
+    has_one_attr :items, 'Habarico::FieldSchema'
+
+    # Schema of properties in case of 'object' type
+    has_many_attr :properties, 'Habarico::FieldSchema'
+
+    # Additional options for the value formating and display
+    has_one_attr :options, 'Habarico::FieldOptions'
+
+    # Flag indicating if the filter is always visible in the filters panel and cannot be removed by the user
+    boolean_attr :is_always_on
+
+  end
+end

data/lib/habarico/schema/endpoint/image_field_options.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class ImageFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Width to resize the image to (in pixels)
+    integer_attr :resize_width
+
+    # Aspect ratio to crop the image to (e.g. '16:9', '4:3')
+    string_attr :crop_aspect_ratio
+
+  end
+end

data/lib/habarico/schema/endpoint/key_value.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class KeyValue
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Key of the pair
+    string_attr :key
+
+    # Value of the pair
+    string_attr :value
+
+  end
+end

data/lib/habarico/schema/endpoint/method_schema.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class MethodSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # List of fields supported by the API
+    has_many_attr :fields, 'Habarico::FieldSchema'
+
+    # List of filters supported by the API
+    has_many_attr :filters, 'Habarico::FilterSchema'
+
+  end
+end

data/lib/habarico/schema/endpoint/number_field_options.rb

@@ -0,0 +1,24 @@
+module Habarico
+  class NumberFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Style of the number formatting
+    string_attr :style
+    enum_attr :style, %i[currency unit]
+
+    # Currency code used in case of "currency" format
+    string_attr :currency
+
+    # Unit used in case of "unit" format
+    string_attr :unit
+
+    # Minimum number of fraction digits
+    integer_attr :minimum_fraction_digits
+
+    # Maximum number of fraction digits
+    integer_attr :maximum_fraction_digits
+
+  end
+end

data/lib/habarico/schema/endpoint/phone_field_options.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class PhoneFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Default region code for phone number parsing and formatting (e.g. 'CZ')
+    string_attr :default_region
+
+    # List of allowed region codes (e.g. ['CZ', 'SK'])
+    has_many_attr :allowed_regions, 'String'
+
+  end
+end

data/lib/habarico/schema/endpoint/relation_field_options.rb

@@ -0,0 +1,39 @@
+module Habarico
+  class RelationFieldOptions
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Show a link to the related resource detail
+    boolean_attr :show_link
+
+    # How to open the linked resource detail (redirect to page or open in a dialog)
+    string_attr :link_mode
+    enum_attr :link_mode, %i[redirect dialog]
+
+    # Width of the dialog, only used when link_mode is dialog (MUI breakpoint or CSS width value)
+    string_attr :dialog_width
+
+    # Keep the linked parent in the URL when navigating to linked resource
+    boolean_attr :keep_linked_parent
+
+    # Show edit button for inline editing of the related resource
+    boolean_attr :show_edit_button
+
+    # Show create button for inline creation of a new related resource
+    boolean_attr :show_create_button
+
+    # Preserve the order of the values according to the order in the source field
+    boolean_attr :preserve_order
+
+    # Static key-value filters applied to the relation resource query
+    has_many_attr :filters, 'Habarico::KeyValue'
+
+    # Default sorting applied to the relation resource query
+    has_one_attr :sort, 'Habarico::SortDescriptor'
+
+    # Name of the parent field this field depends on (used for tree/hierarchical relations)
+    string_attr :parent
+
+  end
+end

data/lib/habarico/schema/extensible_enum.rb

@@ -0,0 +1,20 @@
+module Habarico
+  # Declares an `enum_attr` whose choices come from an extensible list in `Habarico::Types`.
+  #
+  # Identical to calling `enum_attr :type, Types::FIELD_TYPE` directly, except that the class is
+  # recorded as a consumer of that list, so `Types.register` can re-declare the enum when a
+  # pro/enterprise gem adds a value (HAB-812). Without the record the registration would be
+  # invisible here: `enum_attr` copies the choices into the class at declaration time.
+  module ExtensibleEnum
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def extensible_enum_attr(attr_name, list_name)
+        Types.consumers[list_name.to_sym] << [self, attr_name.to_sym]
+        enum_attr attr_name, Types.const_get(list_name)
+      end
+    end
+  end
+end

data/lib/habarico/schema/menu/action_view_choice.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class ActionViewChoice
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Human-readable label of the choice
+    string_attr :label
+
+    # Parameters associated with the choice, passed to the view when selected
+    has_many_attr :parameters, 'String', underlying_type: :hash
+
+  end
+end

data/lib/habarico/schema/menu/menu_group_schema.rb

@@ -0,0 +1,26 @@
+module Habarico
+  class MenuGroupSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the menu item or group, used for coupling with each other
+    string_attr :name
+
+    # Human-readable label for the menu item or group
+    string_attr :label
+
+    # Icon for the menu item or group
+    string_attr :icon
+
+    # Color of the menu item or group. Uses standard MUI color types
+    string_attr :color
+    enum_attr :color, Types::COLOR_TYPE
+
+    # Priority for ordering menu items in the menu
+    integer_attr :priority
+
+    # Parent menu group for nested menu structures
+    has_one_attr :parent, 'Habarico::MenuGroupSchema'
+  end
+end

data/lib/habarico/schema/menu/menu_schema.rb

@@ -0,0 +1,36 @@
+module Habarico
+  class MenuSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the menu item or group, used for coupling with each other
+    string_attr :name
+
+    # Human-readable label for the menu item or group
+    string_attr :label
+
+    # Icon for the menu item or group
+    string_attr :icon
+
+    # Color of the menu item or group. Uses standard MUI color types
+    string_attr :color
+    enum_attr :color, Types::COLOR_TYPE
+
+    # Priority for ordering menu items in the menu
+    integer_attr :priority
+
+    # Type of the menu item
+    string_attr :type
+    enum_attr :type, Types::MENU_TYPE
+
+    # View parameters for menu items of type 'view'
+    has_one_attr :view, 'Habarico::ViewActionParameters'
+
+    # Link parameters for menu items of type 'link'
+    has_one_attr :link, 'Habarico::LinkActionParameters'
+
+    # Parent menu group for nested menu structures
+    has_one_attr :parent, 'Habarico::MenuGroupSchema'
+  end
+end