erupt-sdk 0.1.0

data/sig/erupt/types.rbs

@@ -0,0 +1,408 @@
+# Generated by tools/gen_types.rb from erupt-annotations.schema.json; do not edit.
+# Annotation attributes as RBS records: every key is optional, a declaration only overrides the
+# defaults the Java proxies emit.
+module Erupt
+  type attachment_type = {
+    ?fileSeparator: String, # default "|"
+    ?fileTypes: Array[String], # default []
+    ?imageType: attachment_type_image_type,
+    ?maxLimit: Integer, # default 1
+    ?path: String, # default ""
+    ?size: Integer, # default -1
+    ?type: attachment_type_type # default "BASE"
+  }
+  type attachment_type_image_type = {
+    ?maxHeight: Integer, # default 2147483647
+    ?maxWidth: Integer, # default 2147483647
+    ?minHeight: Integer, # default 0
+    ?minWidth: Integer # default 0
+  }
+  type attachment_type_type = "BASE" | "IMAGE"
+  type auto_complete_type = {
+    ?triggerLength: Integer # default 1
+  }
+  type board_view = {
+    ?groupField: String,
+    ?sumField: String, # default ""
+    ?swimlaneField: String, # default ""
+    ?wipLimit: Integer # default 0
+  }
+  type bool_type = {
+    ?falseText: String, # default "N"
+    ?trueText: String, # default "Y"
+    ?type: bool_type_type # default "AUTO"
+  }
+  type bool_type_type = "AUTO" | "RADIO" | "SWITCH"
+  type button_type = {
+    ?confirm: String, # default ""
+    ?danger: bool, # default false
+    ?fullSpan: bool, # default false
+    ?icon: String, # default ""
+    ?style: String # default "default"
+  }
+  type calendar_view = {
+    ?colorField: String, # default ""
+    ?dateField: String,
+    ?endDateField: String, # default ""
+    ?mode: calendar_view_mode # default "MONTH"
+  }
+  type calendar_view_mode = "MONTH" | "WEEK" | "YEAR"
+  type callout_type = {
+    ?style: callout_type_style, # default "CARD"
+    ?value: String # default ""
+  }
+  type callout_type_style = "CARD" | "INFO" | "SUCCESS" | "WARNING" | "ERROR"
+  type card_view = {
+    ?coverEffect: card_view_cover_effect, # default "CLIP"
+    ?coverField: String # default ""
+  }
+  type card_view_cover_effect = "FIT" | "CLIP"
+  type choice_type = {
+    ?dependField: String, # default ""
+    ?fetchHandler: Array[String], # default []
+    ?type: choice_type_type, # default "SELECT"
+    ?validate: bool # default true
+  }
+  type choice_type_type = "SELECT" | "RADIO"
+  type code_editor_type = {
+    ?height: Integer, # default 300
+    ?hintHandler: Array[String], # default []
+    ?hints: Array[String], # default []
+    ?language: String
+  }
+  type color_type = {
+    ?alpha: bool, # default false
+    ?presets: Array[String], # default []
+    ?showText: bool # default true
+  }
+  type cube_chart = {
+    ?series: String, # default ""
+    ?span: Integer, # default 1
+    ?title: String, # default ""
+    ?type: cube_chart_type,
+    ?ui: Hash[Symbol | String, kv], # keyed by key
+    ?x: Array[String], # default []
+    ?y: Array[String] # default []
+  }
+  type cube_chart_type = "LINE" | "AREA" | "BAR" | "COLUMN" | "PIE" | "SCATTER" | "RADAR" | "FUNNEL" | "DUAL_AXES" | "GAUGE" | "WATERFALL" | "WORD_CLOUD" | "ROSE" | "RADIAL_BAR" | "SANKEY" | "CHORD" | "MAP" | "BUBBLE" | "TREEMAP" | "HEATMAP" | "TINY_LINE" | "TINY_AREA" | "TINY_COLUMN" | "PROGRESS" | "RING_PROGRESS" | "TABLE" | "PIVOT_TABLE" | "KPI"
+  type cube_view = {
+    ?charts: Array[cube_chart],
+    ?columns: Integer, # default 2
+    ?cube: String, # default "Void"
+    ?explore: String, # default "overview"
+    ?height: Integer, # default 320
+    ?linkSearch: bool, # default true
+    ?searchMapping: Hash[Symbol | String, kv] # keyed by key
+  }
+  type date_type = {
+    ?max: String, # default ""
+    ?min: String, # default ""
+    ?pickerMode: date_type_picker_mode, # default "ALL"
+    ?type: date_type_type # default "AUTO"
+  }
+  type date_type_picker_mode = "ALL" | "FUTURE" | "HISTORY"
+  type date_type_type = "AUTO" | "DATE" | "TIME" | "DATE_TIME" | "MONTH" | "WEEK" | "QUARTER" | "YEAR"
+  type drag_sort = {
+    ?field: String
+  }
+  type drill = {
+    ?code: String, # default ""
+    ?fold: bool, # default false
+    ?icon: String, # default "fa fa-sitemap"
+    ?link: link,
+    ?title: String
+  }
+  type dynamic = {
+    ?condition: String,
+    ?dependField: String,
+    ?match: dynamic_ctrl, # default "SHOW"
+    ?noMatch: dynamic_ctrl # default "HIDE"
+  }
+  type dynamic_ctrl = "SHOW" | "HIDE" | "NOTNULL" | "READONLY"
+  type edit = {
+    ?ai: bool, # default true; only when #item.type().toString()=='AUTO' || #item.type().toString()=='INPUT' || #item.type().toString()=='TEXTAREA' || #item.type().toString()=='HTML_EDITOR' || #item.type().toString()=='CODE_EDITOR' || #item.type().toString()=='MARKDOWN'
+    ?attachmentType: attachment_type, # only when #item.type().toString()=='ATTACHMENT'
+    ?autoCompleteType: auto_complete_type, # only when #item.type().toString()=='AUTO_COMPLETE'
+    ?boolType: bool_type, # only when #item.type().toString()=='BOOLEAN'
+    ?buttonType: button_type, # only when #item.type().toString()=='BUTTON'
+    ?calloutType: callout_type, # only when #item.type().toString()=='CALLOUT'
+    ?cellEdit: bool, # default true
+    ?choiceType: choice_type, # only when #item.type().toString()=='CHOICE'
+    ?codeEditType: code_editor_type, # only when #item.type().toString()=='CODE_EDITOR'
+    ?colorType: color_type, # only when #item.type().toString()=='COLOR'
+    ?dateType: date_type, # only when #item.type().toString()=='DATE'
+    ?desc: String, # default ""
+    ?dynamic: dynamic, # only when #value.condition() != ''
+    ?groupType: group_type, # only when #item.type().toString()=='GROUP'
+    ?htmlEditorType: html_editor_type, # only when #item.type().toString()=='HTML_EDITOR'
+    ?inputType: input_type, # only when #item.type().toString()=='INPUT'
+    ?keyValueType: key_value_type, # only when #item.type().toString()=='KEY_VALUE'
+    ?multiChoiceType: multi_choice_type, # only when #item.type().toString()=='MULTI_CHOICE'
+    ?notNull: bool, # default false
+    ?numberType: number_type, # only when #item.type().toString()=='NUMBER'
+    ?onchange: String, # default "OnChange"
+    ?placeHolder: String, # default ""
+    ?rateType: rate_type, # only when #item.type().toString()=='RATE'
+    ?readOnly: readonly,
+    ?referenceTableType: reference_table_type, # only when #item.type().toString()=='REFERENCE_TABLE' || #item.type().toString()=='TAB_TABLE_REFER'
+    ?referenceTreeType: reference_tree_type, # only when #item.type().toString()=='REFERENCE_TREE'
+    ?search: search,
+    ?show: bool, # default true
+    ?sliderType: slider_type, # only when #item.type().toString()=='SLIDER'
+    ?tagsType: tags_type, # only when #item.type().toString()=='TAGS'
+    ?textareaType: textarea_type, # only when #item.type().toString()=='TEXTAREA'
+    ?title: String,
+    ?type: edit_type # default "AUTO"
+  }
+  type edit_type = "AUTO" | "INPUT" | "PASSWORD" | "NUMBER" | "SLIDER" | "COLOR" | "ICON" | "KEY_VALUE" | "RATE" | "DATE" | "BOOLEAN" | "CHOICE" | "MULTI_CHOICE" | "TAGS" | "AUTO_COMPLETE" | "TEXTAREA" | "HTML_EDITOR" | "CODE_EDITOR" | "MARKDOWN" | "ATTACHMENT" | "MAP" | "TPL" | "DIVIDE" | "GROUP" | "CALLOUT" | "BUTTON" | "HIDDEN" | "EMPTY" | "SIGNATURE" | "REFERENCE_TREE" | "REFERENCE_TABLE" | "CHECKBOX" | "TRANSFER" | "TAB_TREE" | "TAB_TABLE_REFER" | "TAB_TABLE_ADD" | "MULTI_FORM" | "COMBINE"
+  type erupt = {
+    ?dataProxyParams: Array[String], # default []
+    ?desc: String, # default ""
+    ?dragSort: drag_sort, # only when #value.field() != ''
+    ?drills: Array[drill], # default []
+    ?extra: Hash[Symbol | String, untyped],
+    ?layout: layout,
+    ?linkTree: link_tree, # only when #value.field() != ''
+    ?param: Hash[Symbol | String, kv], # keyed by key
+    ?primaryKeyCol: String, # default "id"
+    ?rowOperation: Array[row_operation], # default []
+    ?tree: tree,
+    ?vis: Array[vis], # default []
+    ?visRawTable: bool # default true
+  }
+  type erupt_field = {
+    ?edit: edit,
+    ?params: Hash[Symbol | String, kv], # keyed by key
+    ?views: Array[view] # default []
+  }
+  type expr = {
+    ?value: String # default ""
+  }
+  type gantt_view = {
+    ?colorField: String, # default ""
+    ?dependencyField: String, # default ""
+    ?endDateField: String,
+    ?groupField: String, # default ""
+    ?milestoneField: String, # default ""
+    ?pidField: String, # default ""
+    ?progressField: String, # default ""
+    ?startDateField: String
+  }
+  type group_type = {
+    ?collapsed: bool, # default false
+    ?fields: Array[String]
+  }
+  type html_editor_type = {
+    ?path: String, # default ""
+    ?value: html_editor_type_type
+  }
+  type html_editor_type_type = "CKEDITOR" | "UEDITOR"
+  type input_type = {
+    ?fullSpan: bool, # default false
+    ?length: Integer, # default 255
+    ?prefix: Array[vl], # default []
+    ?regex: String, # default ""
+    ?suffix: Array[vl], # default []
+    ?type: String # default "text"
+  }
+  type kv = {
+    ?desc: String, # default ""
+    ?key: String,
+    ?value: String
+  }
+  type key_value_type = {
+    ?keyPlaceholder: String, # default ""
+    ?keys: Array[String], # default []
+    ?max: Integer, # default 0
+    ?valuePlaceholder: String # default ""
+  }
+  type layout = {
+    ?collapseActionButton: bool, # default false
+    ?formSize: layout_form_size, # default "DEFAULT"
+    ?formSteps: bool, # default false
+    ?pageSize: Integer, # default 10
+    ?pageSizes: Array[Integer], # default [10,20,30,50,100,300,500]
+    ?pagingType: layout_paging_type, # default "BACKEND"
+    ?refreshTime: Integer, # default -1
+    ?tableLeftFixed: Integer, # default 0
+    ?tableOperatorWidth: String, # default ""
+    ?tableRightFixed: Integer, # default 0
+    ?tableTruncate: bool, # default true
+    ?tableWidth: String # default ""
+  }
+  type layout_form_size = "DEFAULT" | "FULL_LINE"
+  type layout_paging_type = "BACKEND" | "FRONT" | "NONE"
+  type link = {
+    ?linkCondition: String, # default ""
+    ?linkErupt: String
+  }
+  type link_tree = {
+    ?dependNode: bool, # default false
+    ?field: String
+  }
+  type map_view = {
+    ?cluster: bool, # default true
+    ?colorField: String, # default ""
+    ?latField: String, # default ""
+    ?lngField: String, # default ""
+    ?locationField: String # default ""
+  }
+  type multi_choice_type = {
+    ?dependField: String, # default ""
+    ?fetchHandler: Array[String], # default []
+    ?type: multi_choice_type_type, # default "CHECKBOX"
+    ?validate: bool # default true
+  }
+  type multi_choice_type_type = "SELECT" | "CHECKBOX" | "TRANSFER"
+  type number_type = {
+    ?max: Integer, # default 2147483647
+    ?min: Integer, # default -2147483647
+    ?precision: Integer, # default -1
+    ?prefix: String, # default ""
+    ?step: Numeric, # default 1.0
+    ?suffix: String, # default ""
+    ?thousandsSeparator: bool # default false
+  }
+  type open_way = "DRAWER" | "MODAL" | "ROUTER"
+  type page_embed_type = "IFRAME" | "MICRO_FRONTEND"
+  type placement = "TOP" | "BOTTOM" | "LEFT" | "RIGHT"
+  type query_expression = "AUTO" | "EQ" | "NEQ" | "GT" | "GTE" | "LT" | "LTE" | "LIKE" | "NOT_LIKE" | "RANGE" | "IN" | "NOT_IN" | "NULL" | "NOT_NULL"
+  type rate_type = {
+    ?allowHalf: bool, # default false
+    ?character: String, # default ""
+    ?count: Integer # default 5
+  }
+  type readonly = {
+    ?add: bool, # default true
+    ?allowChange: bool, # default true
+    ?edit: bool # default true
+  }
+  type reference_table_type = {
+    ?dependField: String, # default ""
+    ?id: String, # default "id"
+    ?label: String # default "name"
+  }
+  type reference_tree_type = {
+    ?dependField: String, # default ""
+    ?expandLevel: Integer, # default 999
+    ?id: String, # default "id"
+    ?label: String, # default "name"
+    ?pid: String, # default ""
+    ?rootPid: expr
+  }
+  type row_operation = {
+    ?callHint: String, # default "erupt.operation.call_hint"
+    ?code: String, # default ""
+    ?eruptClass: String, # default "void"
+    ?fold: bool, # default false
+    ?icon: String, # default "fa fa-dot-circle-o"
+    ?ifExpr: String, # default ""
+    ?ifExprBehavior: row_operation_if_expr_behavior, # default "DISABLE"
+    ?mode: row_operation_mode, # default "MULTI"
+    ?tip: String, # default ""
+    ?title: String,
+    ?tpl: tpl,
+    ?type: row_operation_type # default "ERUPT"
+  }
+  type row_operation_if_expr_behavior = "HIDE" | "DISABLE"
+  type row_operation_mode = "SINGLE" | "MULTI" | "MULTI_ONLY" | "BUTTON"
+  type row_operation_type = "ERUPT" | "TPL"
+  type search = {
+    ?lockOperator: bool, # default false
+    ?notNull: bool, # default false
+    ?operator: query_expression, # default "AUTO"
+    ?value: bool # default true
+  }
+  type slider_type = {
+    ?dots: bool, # default false
+    ?markPoints: Array[Numeric], # default []
+    ?max: Integer,
+    ?min: Integer, # default 0
+    ?step: Numeric # default 1.0
+  }
+  type table_view = {
+    ?collapsed: bool, # default false
+    ?groupField: String # default ""
+  }
+  type tags_type = {
+    ?allowExtension: bool, # default true
+    ?fetchHandler: Array[String], # default []
+    ?joinSeparator: String, # default "[]"
+    ?maxTagCount: Integer, # default 9999
+    ?tags: Array[String] # default []
+  }
+  type textarea_type = {
+    ?length: Integer, # default 2147483647
+    ?maxRows: Integer, # default 20
+    ?mentionFetchHandler: Array[String], # default []
+    ?mentionPrefix: Array[String], # default []
+    ?minRows: Integer # default 3
+  }
+  type timeline_view = {
+    ?colorField: String, # default ""
+    ?dateField: String,
+    ?descending: bool, # default true
+    ?mode: timeline_view_mode # default "LEFT"
+  }
+  type timeline_view_mode = "LEFT" | "ALTERNATE" | "RIGHT"
+  type tpl = {
+    ?drawerPlacement: placement, # default "RIGHT"
+    ?embedType: page_embed_type, # default "IFRAME"
+    ?enable: bool, # default true
+    ?height: String, # default ""
+    ?openWay: open_way, # default "MODAL"
+    ?path: String,
+    ?width: String # default ""
+  }
+  type tree = {
+    ?expandLevel: Integer, # default 999
+    ?id: String, # default "id"
+    ?label: String, # default "name"
+    ?maxLevel: Integer, # default 0
+    ?pid: String # default ""
+  }
+  type vl = {
+    ?color: String, # default ""
+    ?desc: String, # default ""
+    ?disable: bool, # default false
+    ?extra: String, # default ""
+    ?label: String,
+    ?value: String
+  }
+  type view = {
+    ?className: String, # default ""
+    ?column: String, # default ""
+    ?desc: String, # default ""
+    ?export: bool, # default true
+    ?group: String, # default ""
+    ?show: bool, # default true
+    ?sortable: bool, # default false
+    ?statistic: view_statistic, # default "NONE"
+    ?template: String, # default ""
+    ?title: String,
+    ?tpl: tpl,
+    ?type: view_type, # default "AUTO"
+    ?width: String # default ""
+  }
+  type view_statistic = "NONE" | "COUNT" | "DISTINCT_COUNT" | "SUM" | "AVG" | "MAX" | "MIN"
+  type view_type = "AUTO" | "TEXT" | "COLOR" | "ICON" | "KEY_VALUE" | "SAFE_TEXT" | "IMAGE" | "AVATAR" | "IMAGE_BASE64" | "SWF" | "HTML" | "MOBILE_HTML" | "QR_CODE" | "LINK" | "LINK_DIALOG" | "DOWNLOAD" | "ATTACHMENT" | "ATTACHMENT_DIALOG" | "DATE" | "DATE_TIME" | "BOOLEAN" | "NUMBER" | "PROGRESS" | "MAP" | "CODE" | "TAB_VIEW" | "MARKDOWN" | "PASSWORD"
+  type vis = {
+    ?boardView: board_view, # only when #item.type().toString() == 'BOARD'
+    ?calendarView: calendar_view, # only when #item.type().toString() == 'CALENDAR'
+    ?cardView: card_view, # only when #item.type().toString() == 'CARD'
+    ?code: String, # default ""
+    ?cubeView: cube_view, # only when #item.type().toString() == 'CUBE'
+    ?desc: String, # default ""
+    ?fieldVisibility: vis_field_visibility, # default "EXCLUDE"
+    ?fields: Array[String], # default []
+    ?ganttView: gantt_view, # only when #item.type().toString() == 'GANTT'
+    ?mapView: map_view, # only when #item.type().toString() == 'MAP'
+    ?tableView: table_view, # only when #item.type().toString() == 'TABLE'
+    ?timelineView: timeline_view, # only when #item.type().toString() == 'TIMELINE'
+    ?title: String,
+    ?tplView: tpl, # only when #item.type().toString() == 'TPL'
+    ?type: vis_type # default "TABLE"
+  }
+  type vis_field_visibility = "INCLUDE" | "EXCLUDE"
+  type vis_type = "TABLE" | "GANTT" | "CARD" | "BOARD" | "CALENDAR" | "TIMELINE" | "MAP" | "CUBE" | "TPL"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: erupt-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YuePeng
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'An erupt cloud node: declare models in Ruby, the erupt server renders
+  the admin UI. Rack compatible, with a built-in HTTP server; no runtime dependencies.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/erupt-sdk.rb
+- lib/erupt.rb
+- lib/erupt/defaults.json
+- lib/erupt/http_server.rb
+- lib/erupt/model.rb
+- lib/erupt/node.rb
+- lib/erupt/repository.rb
+- lib/erupt/schema.json
+- lib/erupt/schema.rb
+- lib/erupt/signature.rb
+- lib/erupt/sql.rb
+- lib/erupt/types.rb
+- lib/erupt/version.rb
+- sig/erupt/types.rbs
+homepage: https://github.com/erupt-io/erupt-sdk/tree/main/ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/erupt-io/erupt-sdk
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Serve Ruby models as an erupt admin UI through an erupt cloud server
+test_files: []