Merge pull request #292 from code0-tech/feat/#291

Differentiate between FlowTypes and RuntimeFlowTypes

Author: nicosammito

README.md

@@ -71,7 +71,8 @@ services that Sagittarius must implement as a server.
     ├── errors - Defines error object
     ├── execution_result - Defines execution result of a flow
     ├── flow - Defines the flow to execute
-    ├── flow_type - Defines types for flows
+    ├── flow_type - Defines types for flows based upon runtime flow types
+    ├── runtime_flow_type - Defines runtime / primitive types for flows
     ├── function - Defines a function
     ├── module - Defines group of functions, runtime functions, flow types and data types
     ├── runtime_function - Defines a runtime function

proto/shared/shared.flow_type.proto

@@ -24,6 +24,7 @@ message FlowType {
   optional string definition_source = 11;
   repeated string linked_data_type_identifiers = 12;
   string signature = 13;
+  string runtime_identifier = 14;
 }
 
 message FlowTypeSetting {
@@ -38,4 +39,6 @@ message FlowTypeSetting {
   optional shared.Value default_value = 3;
   repeated shared.Translation name = 4;
   repeated shared.Translation description = 5;
+  optional bool optional = 6;
+  optional bool hidden = 7;
 }

proto/shared/shared.module.proto

@@ -9,6 +9,7 @@ import "shared.data_type.proto";
 import "shared.function.proto";
 import "shared.runtime_function.proto";
 import "shared.flow_type.proto";
+import "shared.runtime_flow_type.proto";
 import "shared.struct.proto";
 
 message Module {
@@ -21,11 +22,12 @@ message Module {
   string version = 7; // version of the module. Format: "major.minor.patch", e.g. "1.2.3"
 
   repeated shared.FlowType flow_types = 9;
-  repeated shared.FunctionDefinition function_definitions = 10;
-  repeated shared.RuntimeFunctionDefinition runtime_function_definitions = 11;
-  repeated shared.DefinitionDataType definition_data_types = 12;
+  repeated shared.RuntimeFlowType runtime_flow_types = 10;
+  repeated shared.FunctionDefinition function_definitions = 11;
+  repeated shared.RuntimeFunctionDefinition runtime_function_definitions = 12;
+  repeated shared.DefinitionDataType definition_data_types = 13;
 
-  repeated ModuleConfigurationDefinition configurations = 13;
+  repeated ModuleConfigurationDefinition configurations = 14;
 }
 
 //send by sagittarius to inform a module of the real config set by the user

proto/shared/shared.runtime_flow_type.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+option ruby_package = "Tucana::Shared";
+
+package shared;
+
+import "shared.translation.proto";
+import "shared.struct.proto";
+
+message RuntimeFlowType {
+  string identifier = 1;
+  repeated RuntimeFlowTypeSetting runtime_settings = 2;
+  bool editable = 3;
+  repeated shared.Translation name = 4;
+  repeated shared.Translation description = 5;
+  repeated shared.Translation documentation = 6;
+  repeated shared.Translation display_message = 7;
+  repeated shared.Translation alias = 8;
+  // Version of the flow type
+  // Format: "major.minor.patch", e.g. "1.2.3"
+  string version = 9;
+  string display_icon = 10;
+  // Identifier of the service that defines this definition
+  optional string definition_source = 11;
+  repeated string linked_data_type_identifiers = 12;
+  string signature = 13;
+}
+
+message RuntimeFlowTypeSetting {
+  enum UniquenessScope {
+    UNKNOWN = 0;
+    NONE = 1;
+    PROJECT = 2;
+  }
+
+  string identifier = 1;
+  UniquenessScope unique = 2;
+  optional shared.Value default_value = 3;
+  repeated shared.Translation name = 4;
+  repeated shared.Translation description = 5;
+  optional bool optional = 6;
+  optional bool hidden = 7;
+}