Feature/12 feature type definition UI

README.md

@@ -46,14 +46,63 @@ When one agent introduces information to another agent that presents a conflict
 
 ## Modularization
 
-* core
-  * entities
-  * interactors
-  * data
-  * local
-  * remote
-  * view-models
-  * ui
-* feature
-  * ontology - enables users to document their perspective as discrete elements and their relations
-  * epistemology - enables users to compare and test differences in ontologies
+Ontology - enables users to document their perspective as discrete elements and their relations
+Epistemology - enables users to compare and test differences in ontologies
+
+```mermaid
+%%{
+  init: {
+    'theme': 'neutral'
+  }
+}%%
+
+graph LR
+  :app-android --> :app-shared
+  :app-desktop --> :app-shared
+
+  :app-shared --> :feature:ontology
+  :app-shared --> :feature:epistemology
+
+  :feature:ontology --> :core-all
+  :feature:epistemology --> :core-all
+
+  :core-all --> :core:common
+  :core-all --> :core:entities
+  :core-all --> :core:interactors
+  :core-all --> :core:data
+  :core-all --> :core:remote
+  :core-all --> :core:local
+  :core-all --> :core:view-models
+  :core-all --> :core:ui
+  :core-all --> :core:navigation
+
+  :core:ui --> :core:entities
+  :core:ui --> :core:common
+
+  :core:data --> :core:common
+  :core:data --> :core:entities
+  :core:data --> :core:local
+  :core:data --> :core:remote
+
+  :core:entities --> :core:common
+
+  :core:interactors --> :core:common
+  :core:interactors --> :core:data
+
+  :core:local --> :core:common
+  :core:local --> :core:entities
+
+  :core:navigation --> :core:common
+  :core:navigation --> :core:entities
+
+  :core:remote --> :core:common
+  :core:remote --> :core:entities
+
+  :core:ui --> :core:common
+  :core:ui --> :core:entities
+  :core:ui --> :core:view-models
+
+  :core:view-models --> :core:common
+  :core:view-models --> :core:entities
+  :core:view-models --> :core:interactors
+```

app-android/build.gradle.kts

@@ -7,11 +7,11 @@ plugins {
 
 android {
     namespace = "org.pointyware.commonsense.android"
-    compileSdk = 34
+    compileSdk = 35
     defaultConfig {
         applicationId = "org.pointyware.commonsense.android"
         minSdk = 24
-        targetSdk = 34
+        targetSdk = 35
         versionCode = 1
         versionName = "1.0"
     }

app-shared/build.gradle.kts

@@ -114,7 +114,7 @@ compose.resources {
 
 android {
     namespace = "org.pointyware.commonsense.shared"
-    compileSdk = 34
+    compileSdk = 35
     defaultConfig {
         minSdk = 21
     }

core/common/build.gradle.kts

@@ -79,7 +79,7 @@ kotlin {
 
 android {
     namespace = "org.pointyware.commonsense.core.common"
-    compileSdk = 34
+    compileSdk = 35
     defaultConfig {
         minSdk = 21
     }

core/common/src/commonMain/kotlin/MapExt.kt

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2024 Pointyware. Use of this software is governed by the GPL-3.0 license.
+ */
+
+package org.pointyware.commonsense.core.common
+
+/**
+ *
+ */
+fun <K, V> Map<K, V>.joinToString() {
+    entries.joinToString(prefix = "{", separator = ", ", postfix = "}") { (k, v) -> "$k=$v" }
+}

core/data/build.gradle.kts

@@ -81,7 +81,7 @@ kotlin {
 
 android {
     namespace = "org.pointyware.commonsense.core.data"
-    compileSdk = 34
+    compileSdk = 35
     defaultConfig {
         minSdk = 21
     }

core/data/src/commonMain/kotlin/org/pointyware/commonsense/core/data/db/Document.kt

@@ -1,8 +1,11 @@
+@file:OptIn(ExperimentalUuidApi::class)
+
 package org.pointyware.commonsense.core.data.org.pointyware.commonsense.core.data.db
 
-import org.pointyware.commonsense.core.common.Uuid
 import org.pointyware.commonsense.core.entities.Type
 import org.pointyware.commonsense.core.entities.Value
+import kotlin.uuid.ExperimentalUuidApi
+import kotlin.uuid.Uuid
 
 /**
  * Represents a document that can be stored in a graph database. A node in a graph.

core/entities/build.gradle.kts

@@ -79,7 +79,7 @@ kotlin {
 
 android {
     namespace = "org.pointyware.commonsense.core.entities"
-    compileSdk = 34
+    compileSdk = 35
     defaultConfig {
         minSdk = 21
     }

core/entities/src/commonMain/kotlin/org/pointyware/commonsense/core/entities/Field.kt

@@ -6,7 +6,7 @@ package org.pointyware.commonsense.core.entities
 data class Field<T:Type>(
     val name: String,
     val type: T,
-    var value: Value<T>
+    val defaultValue: Value<T>? = null
 ) {
 
 }

core/entities/src/commonMain/kotlin/org/pointyware/commonsense/core/entities/Type.kt

@@ -1,5 +1,8 @@
 package org.pointyware.commonsense.core.entities
 
+import kotlin.uuid.ExperimentalUuidApi
+import kotlin.uuid.Uuid
+
 @RequiresOptIn(
     message = "This API is experimental and may change in the future.",
     level = RequiresOptIn.Level.WARNING
@@ -14,6 +17,9 @@ annotation class ExperimentalType
  * [Type.Int] is the only non-experimental type.
  */
 sealed interface Type {
+
+    val name: kotlin.String
+
     // region Theoretical Types
 
     /**
@@ -98,68 +104,99 @@ sealed interface Type {
      * <sup>(1)</sup> - [null etymology](https://www.etymonline.com/word/null)
      */
     @ExperimentalType
-    data object Null: Type
+    data object Null: Type {
+        override val name: kotlin.String
+            get() = "Null"
+    }
 
     /**
      * A boolean is a value that can be either true or false.
      */
-    @ExperimentalType
-    data object Boolean: Type
+    data object Boolean: Type {
+        override val name: kotlin.String
+            get() = "Boolean"
+    }
 
     /**
      * An integer is a value that can be represented as a whole number.
      */
-    data object Int: Type // Add min, max constraints or define as further type?
+    data object Int: Type { // Add min, max constraints or define as further type?
+        override val name: kotlin.String
+            get() = "Int"
+    }
 
     /**
      * A floating point number is composed of a sign bit, mantissa, and an exponent.
      */
     @ExperimentalType
-    data object Float: Type // Add min, max constraints or define as further type?
+    data object Float: Type { // Add min, max constraints or define as further type?
+        override val name: kotlin.String
+            get() = "Float"
+    }
 
     // Collections
     /**
      * A collection is a group of objects that are treated as a single entity.
      */
     @ExperimentalType
-    data object Collection: Type
+    data object Collection: Type {
+        override val name: kotlin.String
+            get() = "Collection<E>"
+    }
 
     // Homogenous Collections
     /**
      * A sequence is an ordered collection of objects.
      */
     @ExperimentalType
-    data object Sequence: Type
+    data object Sequence: Type {
+        override val name: kotlin.String
+            get() = "Sequence<E>"
+    }
 
     /**
      * An array is a fixed-size collection of objects.
      */
     @ExperimentalType
-    data object Array: Type // Add size min, max constraints or define as further type?
+    data object Array: Type { // Add size min, max constraints or define as further type?
+        override val name: kotlin.String
+            get() = "Array<E>"
+    }
 
     /**
      * A string is a special case sequence of characters.
      */
-    @ExperimentalType
-    data object String: Type // Add pattern constraints or define as further type?
+    data object String: Type { // Add pattern constraints or define as further type?
+        override val name: kotlin.String
+            get() = "String|Array<Char>"
+    }
 
     /**
      * A set is collection of unique objects.
      */
     @ExperimentalType
-    data object Set: Type
+    data object Set: Type {
+        override val name: kotlin.String
+            get() = "Set<E>"
+    }
 
     /**
      * A bag is a special case of a set where each element can appear more than once.
      */
     @ExperimentalType
-    data object Bag: Type
+    data object Bag: Type {
+        override val name: kotlin.String
+            get() = "Bag<E>"
+    }
 
     /**
      * A map is a special case of a set where each element is a key-value pair.
      */
     @ExperimentalType
-    data object Map: Type
+    data object Map: Type {
+        override val name: kotlin.String
+            get() = "Map<K,V>"
+    }
 
     // Heterogeneous Collections
 
@@ -174,14 +211,38 @@ sealed interface Type {
      * @see Record
      */
     @ExperimentalType
-    data object Object: Type
+    data object Object: Type {
+        override val name: kotlin.String
+            get() = "Object"
+    }
+
 
     /**
      * An interface is a collection of properties that define a contract for objects that implement
      * the interface.
      */
     @ExperimentalType
-    data object Interface: Type
+    data class Interface(
+        override val name: kotlin.String,
+        val fields: List<Field<*>>
+    ): Type {
+        // TODO: interface focus on function signatures
+    }
+
+    /**
+     * A form of Schema that is used to define the structure of a Concept.
+     *
+     * Each Concept belongs to a Class and has a set of Properties.
+     *
+     * TODO: rename to Structure? for lay people
+     */
+    @OptIn(ExperimentalUuidApi::class)
+    data class Record(
+        override val name: kotlin.String,
+        val uuid: Uuid,
+        val fields: kotlin.collections.Set<Field<*>> = emptySet()
+    ): Type {
+    }
 
     // endregion
 }