habarico 7.2.0.pre.beta.5

data/lib/habarico/schema/resource/global_resource_schema.rb

@@ -0,0 +1,14 @@
+module Habarico
+  class GlobalResourceSchema < ResourceSchema
+
+    # List of actions (buttons) available for the resource, for example: "detail", "create", "edit", "delete" or a custom action like "approve"
+    has_many_attr :actions, 'Habarico::GlobalResourceActionSchema'
+
+    # List of views available for the resource, for example: "list", "show", "create", "edit"
+    has_many_attr :views, 'Habarico::GlobalViewSchema'
+
+    # Definition of the menu item and its parents associated with this resource
+    has_one_attr :menu, 'Habarico::MenuSchema'
+
+  end
+end

data/lib/habarico/schema/resource/local_resource_schema.rb

@@ -0,0 +1,14 @@
+module Habarico
+  class LocalResourceSchema < ResourceSchema
+
+    # List of actions (buttons) available for the resource, for example: "detail", "create", "edit", "delete" or a custom action like "approve"
+    has_many_attr :actions, 'Habarico::ResourceActionSchema'
+
+    # List of views available for the resource, for example: "list", "show", "create", "edit"
+    has_many_attr :views, 'Habarico::ViewSchema'
+
+    # Definition of the API underlying this resource
+    has_one_attr :endpoints, 'Habarico::EndpointsSchema'
+
+  end
+end

data/lib/habarico/schema/resource/object_resource_schema.rb

@@ -0,0 +1,8 @@
+module Habarico
+  class ObjectResourceSchema < ResourceSchema
+
+    # List of actions (buttons) available for the resource, for example: "detail", "create", "edit", "delete" or a custom action like "approve"
+    has_many_attr :actions, 'Habarico::ResourceActionSchema'
+
+  end
+end

data/lib/habarico/schema/resource/resource_schema.rb

@@ -0,0 +1,16 @@
+module Habarico
+  class ResourceSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Name of the resource in the API, used for coupling with actions
+    string_attr :name
+
+    # Human-readable label for the resource
+    string_attr :label
+
+    # Primary key field name for the resource, usually "id"
+    string_attr :pk_field_name
+
+  end
+end

data/lib/habarico/schema/types.rb

@@ -0,0 +1,102 @@
+module Habarico
+  # Shared enum value lists.
+  #
+  # Every constant here mirrors one enum entity of the OpenAPI contract (`doc/openapi.yaml`) and is
+  # named after it, so the two can be matched one to one. Schema classes reference these instead of
+  # repeating the values inline, which is what used to let the same enum drift apart between classes.
+  #
+  # The values are the ones Ruby has always sent - aligning them with the contract (Ruby is missing
+  # `export` and `ai-assistant` in ACTION_TYPE and `decimal` / `tree-relation` in FIELD_FORMAT_TYPE)
+  # is tracked separately, see HAB-708 section 6.
+  module Types
+
+    # Four lists below are deliberately *not* frozen and carry a `Style/MutableConstant` disable:
+    # `Types.register` appends to them when a pro/enterprise gem contributes a value (HAB-812).
+    # Freezing them would make that extension point impossible. Every other list is frozen,
+    # because it mirrors a closed enum of the OpenAPI contract that nothing may widen.
+
+    # ColorType - MUI colour palette shared by actions, action descriptors and enum items
+    COLOR_TYPE = %i[primary secondary success error warning info inherit].freeze
+
+    # FieldType - data type of a field or filter
+    FIELD_TYPE = %i[string number integer boolean array object]  # rubocop:disable Style/MutableConstant
+
+    # FieldFormatType - format applied to a field or filter on top of its data type
+    # rubocop:disable-next Style/MutableConstant
+    FIELD_FORMAT_TYPE = %i[date date-time time text rich-text email url password
+                           base64-image base64-file uuid relation choices search phone
+                           czech-bank-account czech-ico czech-dic czech-birth-number
+                           ai ai-text range]
+
+    # BoxType - layout container types
+    BOX_TYPE = %i[tab tab-item wizard simple list object array grid grid-item gallery]  # rubocop:disable Style/MutableConstant
+
+    # ViewType - kind of the view
+    VIEW_TYPE = %i[list show create edit action].freeze
+
+    # ViewModeType - how a view is presented when opened by a trigger
+    VIEW_MODE_TYPE = %i[redirect dialog sidepanel].freeze
+
+    # ActionType - kind of the action
+    ACTION_TYPE = %i[view link resource save upload-images]  # rubocop:disable Style/MutableConstant
+
+    # MenuType - kind of the menu item
+    MENU_TYPE = %i[link view text].freeze
+
+    # RequestMethodType - HTTP method of an endpoint
+    REQUEST_METHOD_TYPE = %i[get post patch put delete].freeze
+
+    # SortDirectionType - direction of a sort descriptor
+    SORT_DIRECTION_TYPE = %i[asc desc].freeze
+
+    # LinkTargetType - where a link action opens
+    LINK_TARGET_TYPE = %i[self blank].freeze
+
+    # TextAlignType - horizontal alignment of a field value
+    TEXT_ALIGN_TYPE = %i[left center right].freeze
+
+    # *************************************************************************
+    # Extension point: registering additional values (HAB-812)
+    # *************************************************************************
+
+    # Lists a pro/enterprise gem may extend. The rest stay frozen: they mirror a closed enum of
+    # the OpenAPI contract (`doc/openapi.yaml`) that no gem may widen on its own.
+    #
+    # The whole vocabulary stays in the free core - including values with no Ruby implementation
+    # yet (`upload-images`, `ai`, `ai-text`). The names are a contract shared with the frontend;
+    # what is paid is the implementation behind them, not the name.
+    EXTENSIBLE = %i[FIELD_TYPE FIELD_FORMAT_TYPE BOX_TYPE ACTION_TYPE].freeze
+
+    class << self
+      # Schema classes whose `enum_attr` was declared from a list, as
+      # `{ list_name => [[klass, attr_name], ...] }`. Filled by `ExtensibleEnum`.
+      def consumers
+        @consumers ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      # Add values to an extensible list and re-declare the enum on every schema class built from
+      # it. The re-declaration is what makes this work at all: `enum_attr` copies the choices into
+      # the class when it is called, so appending to the array alone would change nothing.
+      #
+      #   Habarico::Types.register(:FIELD_FORMAT_TYPE, :signature)
+      #
+      # Raises when the list is not extensible or the value is already there.
+      def register(list_name, *values)
+        list_name = list_name.to_sym
+        unless EXTENSIBLE.include?(list_name)
+          raise ArgumentError, "#{list_name} is not extensible. Extensible lists: #{EXTENSIBLE.join(', ')}."
+        end
+
+        list = const_get(list_name)
+        values.map!(&:to_sym)
+        duplicates = values & list
+        raise ArgumentError, "#{list_name} already contains #{duplicates.join(', ')}." if duplicates.any?
+
+        list.concat(values)
+        consumers[list_name].each { |klass, attr_name| klass.enum_attr(attr_name, list) }
+        list
+      end
+    end
+
+  end
+end

data/lib/habarico/schema/view/action_descriptor.rb

@@ -0,0 +1,30 @@
+module Habarico
+  class ActionDescriptor
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the action, used for coupling with resource action schema
+    string_attr :name
+
+    # Override for `label` from action schema
+    string_attr :label
+
+    # Override for `icon` from action schema
+    string_attr :icon
+
+    # Override for `color` from action schema
+    string_attr :color
+    enum_attr :color, Types::COLOR_TYPE
+
+    # Special action in case no resource action schema is coupled
+    has_one_attr :action, 'Habarico::ActionSchema'
+
+    # View parameters for the action descriptor (mode, choices, parameters)
+    has_one_attr :view, 'Habarico::ViewActionDescriptorParameters'
+
+    # Nested menu items for dropdown/submenu actions
+    has_many_attr :menu_items, 'Habarico::ActionDescriptor'
+
+  end
+end

data/lib/habarico/schema/view/array_box_parameters.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class ArrayBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Name of the attribute to be used as target for array operations
+    string_attr :target
+
+    # Whether to render the array box inline
+    boolean_attr :inline
+
+  end
+end

data/lib/habarico/schema/view/box_schema.rb

@@ -0,0 +1,67 @@
+module Habarico
+  class BoxSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+    include Habarico::ExtensibleEnum
+
+    intended_for_types *Types::BOX_TYPE
+
+    # Type of the box
+    string_attr :type
+    extensible_enum_attr :type, :BOX_TYPE
+
+    # Name of the box
+    string_attr :name
+
+    # Human-readable label of the box
+    string_attr :label
+
+    # List of child boxes and fields (polymorphic: FieldDescriptor | BoxSchema)
+    has_many_attr :boxes, ['Habarico::FieldDescriptor', 'Habarico::BoxSchema'], default: 'Habarico::BoxSchema'
+
+    # Flag indicating if the box is or is not editable
+    boolean_attr :read_only
+
+    # Flag indicating if the box is or is not wrapped in a card UI element
+    boolean_attr :card
+
+    # Makes the box collapsible; value sets the default state ('open' = expanded, 'closed' = collapsed).
+    # Null means the box is not collapsible.
+    string_attr :collapsible
+    enum_attr :collapsible, %i[open closed]
+
+    # Actions rendered in this box's local toolbar (box header / card header area), relative to the box root.
+    # On a step container (tab/wizard) the actions appear on the last step. For a 'list' box this is the box-level
+    # toolbar; the table's own toolbar is carried by 'list.toolbar_actions' instead.
+    has_many_attr :toolbar_actions, 'Habarico::ActionDescriptor'
+
+    # Actions rendered at the bottom of the box, below the fields (similar to form submit buttons at the view level).
+    has_many_attr :bottom_actions, 'Habarico::ActionDescriptor'
+
+    # Additional parameters for box type 'tab'
+    has_one_attr :tab, 'Habarico::TabBoxParameters'
+
+    # Additional parameters for box type 'wizard'
+    has_one_attr :wizard, 'Habarico::WizardBoxParameters'
+
+    # Additional parameters for box type 'grid-item'
+    has_one_attr :grid_item, 'Habarico::GridItemBoxParameters'
+
+    # Additional parameters for box type 'list'
+    has_one_attr :list, 'Habarico::ListBoxParameters'
+
+    # Additional parameters for box type 'array'
+    has_one_attr :array, 'Habarico::ArrayBoxParameters'
+
+    # Additional parameters for box type 'object'
+    has_one_attr :object, 'Habarico::ObjectBoxParameters'
+
+    # Additional parameters for box type 'gallery'
+    has_one_attr :gallery, 'Habarico::GalleryBoxParameters'
+
+    # Additional options for the box (e.g. dynamic rendering)
+    has_one_attr :options, 'Habarico::BoxOptions'
+
+  end
+end

data/lib/habarico/schema/view/detail_view_parameters.rb

@@ -0,0 +1,16 @@
+module Habarico
+  class DetailViewParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Definition of a main box
+    has_one_attr :box, 'Habarico::BoxSchema'
+
+    # In case we don't want to show the default set of resource actions, a custom set of action descriptors can be provided and displayed in the tollbar
+    has_many_attr :toolbar_actions, 'Habarico::ActionDescriptor'
+
+    # A set of action descriptors can be provided and displayed under the detail box / form
+    has_many_attr :bottom_actions, 'Habarico::ActionDescriptor'
+
+  end
+end

data/lib/habarico/schema/view/field_descriptor.rb

@@ -0,0 +1,50 @@
+module Habarico
+  class FieldDescriptor
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    intended_for_types :field
+
+    # Type of the descriptor, always 'field'
+    string_attr :type
+    enum_attr :type, [:field]
+
+    # Name of the field in the data model, used for coupling with field schema
+    string_attr :name
+
+    # Override for `label` from field schema
+    string_attr :label
+
+    # Override for `short_label` from field schema
+    string_attr :short_label
+
+    # Override for `help_text` from field schema
+    string_attr :help_text
+
+    # Override for `sortable` from field schema
+    boolean_attr :sortable
+
+    # Override for `sort_by` from field schema
+    string_attr :sort_by
+
+    # Override for `read_only` from field schema
+    boolean_attr :read_only
+
+    # Override for `write_only` from field schema
+    boolean_attr :write_only
+
+    # Override for `default_value` from field schema
+    any_attr :default_value
+
+    # Action to trigger when the field value is clicked
+    has_one_attr :action, 'Habarico::ActionDescriptor'
+
+    # Wrapper properties for grouping multiple fields in one column
+    has_one_attr :wrapper, 'Habarico::FieldWrapperProperties'
+
+    # Override for `options` from field schema
+    has_one_attr :options, 'Habarico::FieldOptions'
+
+  end
+end

data/lib/habarico/schema/view/field_wrapper_properties.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class FieldWrapperProperties
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Fields of the wrapper
+    has_many_attr :fields, 'Habarico::FieldDescriptor'
+
+    # Divider between fields
+    string_attr :divider
+
+  end
+end

data/lib/habarico/schema/view/filter_descriptor.rb

@@ -0,0 +1,24 @@
+module Habarico
+  class FilterDescriptor
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Name of the filter in API, used for coupling with filter schema
+    string_attr :name
+
+    # Override for `label` from filter schema
+    string_attr :label
+
+    # Override for `help_text` from filter schema
+    string_attr :help_text
+
+    # Override for `is_always_on` from filter schema
+    boolean_attr :is_always_on
+
+    # Override for `default_value` from filter schema
+    any_attr :default_value
+
+    # TODO options
+
+  end
+end

data/lib/habarico/schema/view/gallery_box_parameters.rb

@@ -0,0 +1,31 @@
+module Habarico
+  class GalleryBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Reference to another resource
+    string_attr :reference
+
+    # Name of the field containing the image ({url, filename})
+    string_attr :image_field
+
+    # Human-readable label of the box
+    string_attr :label
+
+    # Name of the attribute in the referenced resource used as the coupling value
+    string_attr :target
+
+    # List of filters to be displayed / available to the gallery
+    has_many_attr :filters, 'Habarico::FilterDescriptor'
+
+    # Default sorting for the gallery
+    has_one_attr :default_sorting, 'Habarico::SortDescriptor'
+
+    # Additional filters to be applied to the gallery by default
+    any_attr :extra_filters
+
+    # Additional parameters sent with the get schema request
+    has_many_attr :schema_params, 'String', underlying_type: :hash
+
+  end
+end

data/lib/habarico/schema/view/global_view_schema.rb

@@ -0,0 +1,25 @@
+module Habarico
+  class GlobalViewSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the view, usually "list", "show", "create", "edit"
+    string_attr :name
+
+    # Type of the view
+    string_attr :type
+    enum_attr :type, Types::VIEW_TYPE
+
+    # Flag indicating if the view is detail (uses primary key)
+    boolean_attr :is_detail
+
+    # Default presentation mode when a trigger opens this view without its own mode.
+    # When omitted, the frontend falls back to `redirect`.
+    string_attr :mode
+    enum_attr :mode, Types::VIEW_MODE_TYPE
+
+    # Definition of the endpoint
+    has_one_attr :endpoint, 'Habarico::ViewEndpointParameters'
+  end
+end

data/lib/habarico/schema/view/grid_item_box_parameters.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class GridItemBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    integer_attr :xs
+    integer_attr :sm
+    integer_attr :md
+    integer_attr :lg
+    integer_attr :xl
+
+  end
+end

data/lib/habarico/schema/view/list_box_parameters.rb

@@ -0,0 +1,44 @@
+module Habarico
+  class ListBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Reference to another resource
+    string_attr :reference
+
+    # Name of the attribute in the references resource to use as the coupling value
+    string_attr :target
+
+    # Additional filters to be applied to the list by default, can be used instead of target
+    any_attr :extra_filters
+
+    # List of filters to be displayed / available to the list
+    has_many_attr :filters, 'Habarico::FilterDescriptor'
+
+    # In case we don't want to show the default set of resource actions, a custom set of action descriptors can be provided and displayed in each row
+    has_many_attr :row_actions, 'Habarico::ActionDescriptor'
+
+    # Actions rendered in the table's own toolbar (top of the resource list, e.g. create), separate from the
+    # box-level toolbar which belongs to the box root
+    has_many_attr :toolbar_actions, 'Habarico::ActionDescriptor'
+
+    # Utility actions of the table (export, print, ...) rendered next to the filter bar, separate from row and toolbar actions
+    has_many_attr :list_actions, 'Habarico::ActionDescriptor'
+
+    # Default sorting for the list
+    has_one_attr :default_sorting, 'Habarico::SortDescriptor'
+
+    # Drag & drop sortable configuration
+    has_one_attr :sortable, 'Habarico::SortableParameters'
+
+    # Additional parameters sent with the get schema request
+    has_many_attr :schema_params, 'String', underlying_type: :hash
+
+    # Action to activate on a single row click (e.g. open a record preview in a side panel)
+    has_one_attr :single_click_action, 'Habarico::ActionDescriptor'
+
+    # Action to activate on a row double-click
+    has_one_attr :double_click_action, 'Habarico::ActionDescriptor'
+
+  end
+end

data/lib/habarico/schema/view/list_view_parameters.rb

@@ -0,0 +1,31 @@
+module Habarico
+  class ListViewParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # List of fields to be displayed / available in the list
+    has_many_attr :boxes, 'Habarico::FieldDescriptor'
+
+    # List of filters to be displayed / available to the list
+    has_many_attr :filters, 'Habarico::FilterDescriptor'
+
+    # In case we don't want to show the default set of resource actions, a custom set of action descriptors can be provided and displayed in each row
+    has_many_attr :row_actions, 'Habarico::ActionDescriptor'
+
+    # In case we don't want to show the default set of resource actions, a custom set of action descriptors can be provided and displayed in the tollbar
+    has_many_attr :toolbar_actions, 'Habarico::ActionDescriptor'
+
+    # Utility actions of the table (export, print, ...) rendered next to the filter bar, separate from row and toolbar actions
+    has_many_attr :list_actions, 'Habarico::ActionDescriptor'
+
+    # Default sorting for the list
+    has_one_attr :default_sorting, 'Habarico::SortDescriptor'
+
+    # Action to activate on a single row click (e.g. open a record preview in a side panel)
+    has_one_attr :single_click_action, 'Habarico::ActionDescriptor'
+
+    # Action to activate on a row double-click
+    has_one_attr :double_click_action, 'Habarico::ActionDescriptor'
+
+  end
+end

data/lib/habarico/schema/view/object_box_parameters.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class ObjectBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Name of the nested serializer field used as the target for object operations
+    string_attr :target
+
+  end
+end

data/lib/habarico/schema/view/sort_descriptor.rb

@@ -0,0 +1,15 @@
+module Habarico
+  class SortDescriptor
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the field to sort by
+    string_attr :field_name
+
+    # Direction of the sort
+    string_attr :direction
+    enum_attr :direction, Types::SORT_DIRECTION_TYPE
+
+  end
+end

data/lib/habarico/schema/view/sortable_parameters.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class SortableParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Name of the field to sort by when drag-and-drop reordering
+    string_attr :field_name
+
+    # Additional filters to scope the sortable operation (e.g. group by parent)
+    any_attr :sort_for_filters
+
+  end
+end

data/lib/habarico/schema/view/tab_box_parameters.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class TabBoxParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+
+    # Show previous/next navigation buttons in the box toolbar
+    boolean_attr :show_toolbar_navigation
+
+  end
+end

data/lib/habarico/schema/view/view_action_descriptor_parameters.rb

@@ -0,0 +1,21 @@
+module Habarico
+  class ViewActionDescriptorParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # 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
+
+    # View choices for the action
+    has_many_attr :choices, 'Habarico::ActionViewChoice'
+
+    # Additional parameters for 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/view/view_endpoint_parameters.rb

@@ -0,0 +1,22 @@
+module Habarico
+  class ViewEndpointParameters
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Path of the endpoint to call. Only set when the standard resource path is not used, i.e. for
+    # action views; for the standard views the frontend derives the path from the resource itself.
+    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
+
+  end
+end

data/lib/habarico/schema/view/view_schema.rb

@@ -0,0 +1,33 @@
+module Habarico
+  class ViewSchema
+    include ::ActiveModel::Model
+    include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
+
+    # Name of the view, usually "list", "show", "create", "edit"
+    string_attr :name
+
+    # Type of the view
+    string_attr :type
+    enum_attr :type, Types::VIEW_TYPE
+
+    # Flag indicating if the view is detail (uses primary key)
+    boolean_attr :is_detail
+
+    # Human-readable label of the view
+    string_attr :label
+
+    # Definition of the list, applicable for list views
+    has_one_attr :list, 'Habarico::ListViewParameters'
+
+    # Definition of the detail, applicable for detail views
+    has_one_attr :detail, 'Habarico::DetailViewParameters'
+
+    # Definition of the endpoint
+    has_one_attr :endpoint, 'Habarico::ViewEndpointParameters'
+
+    # Breadcrumbs for navigation in case we need not standard ones
+    has_many_attr :breadcrumbs, 'Habarico::MenuSchema'
+
+  end
+end