Es/feat observation fields

docs/ObservationPresets.MD

@@ -0,0 +1,72 @@
+## Relationship between presets, fields, and tags
+
+### Tags:
+
+An `Observation` has a tags property.
+
+```ts
+type tags = {
+  [k: string]:
+    | boolean
+    | number
+    | string
+    | null
+    | (boolean | number | string | null)[];
+};
+```
+
+This is an open ended propery, that allows any key value pair descriptor to be associated with an observation. For example, any notes associated with a observation is simply saved as a tag, with the `key="notes"`
+
+### Presets:
+
+Presets have a set of predefined tags used to categorize an observation. These tags can have as little or as many descriptors, usually defined by how it is used.
+
+In the following example, there are 2 different types of tags, defined by the presets, both describing bridges.
+
+```ts
+// This tag simply defines the observation as being a bridge
+const tags = {
+  name: 'bridge',
+};
+
+// this tag defines the observation as an active suspension bridge over a river
+const tags = {
+  name: 'bridge',
+  bridgeType: 'suspension',
+  bodyOfWater: 'river',
+  isActive: true,
+};
+```
+
+In CoMapeo each preset represnts one type of observation (defined by the name tag). Preset also includes other meta data associated with an observation.
+
+### Fields:
+
+Fields are also saved to an observation as a tag. The difference is that they are editted by the user at the time of the observation. A `preset` has predefined `keys` and a predefined `values`, while a `tag` has predefined `keys` and user editted values. This is useful when there are descriptors that cannot be predetermined.
+
+Using the bridge example:
+
+```ts
+const tags = {
+  // this is predefined by the preset
+  type: 'bridge',
+  // this is a field, where the user was prompted to input the length
+  lengthInMeter: 35,
+};
+```
+
+### How to determine the fields associated with a preset
+
+`Presets` have a `fieldsId` property of type `string[]`. For each value in the array, there is an associated field with a matching docId.
+
+Each observation can have a several fields associated with it.
+
+Each field has a `type`, where `type: "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";`. This defines how the field is presented to the user,and how the user inputs the value of the field. If the type is `text` or `number` the user inputs a string or number. If the type is `selectOne` or `selectMultiple` the user types is given a list of options to select from which determines the value of the field
+
+A field has a `tagKey` property. This defined the `key` of the tag saved in the observation
+
+### Flow for saving an observation
+
+1. User choses a preset. This preset has `tags` and `fieldIds`.
+2. Based on the `fieldIds` the user is prompted to fill in several forms. This provides an another `tags` object where the `keys=Field['tagKeys']` and the value is the value inputted by the user.
+3. The tags from the preset, and the tags from the fields are flattened into `tags` object of an observation.

docs/ObservationPresets.md

@@ -2,7 +2,7 @@
 
 ### Tags:
 
-An `Observation` has a `tags` property.
+An `Observation` has a tags property.
 
 ```ts
 type tags = {
@@ -15,7 +15,7 @@ type tags = {
 };
 ```
 
-This is an open-ended property that allows any key-value pair descriptor to be associated with an observation. For example, any notes associated with an observation is simply saved as a tag, with the `key="notes"`
+This is an open ended propery, that allows any key value pair descriptor to be associated with an observation. For example, any notes associated with a observation is simply saved as a tag, with the `key="notes"`
 
 ### Presets:
 
@@ -25,24 +25,24 @@ In the following example, there are 2 different types of tags, defined by the pr
 
 ```ts
 // This tag simply defines the observation as being a bridge
-const tag = {
+const tags = {
   name: 'bridge',
 };
 
 // this tag defines the observation as an active suspension bridge over a river
-const tag = {
+const tags = {
   name: 'bridge',
   bridgeType: 'suspension',
   bodyOfWater: 'river',
   isActive: true,
 };
 ```
 
-In CoMapeo each preset represents one type of observation (defined by the `name` tag). Preset also includes other metadata associated with an observation.
+In CoMapeo each preset represnts one type of observation (defined by the name tag). Preset also includes other meta data associated with an observation.
 
 ### Fields:
 
-Fields are also saved to an observation as a tag. The difference is that they are edited by the user at the time of the observation. A `preset` has predefined `keys` and a predefined `values`, while a `tag` has predefined `keys` and user-edited values. This is useful when there are descriptors that cannot be predetermined.
+Fields are also saved to an observation as a tag. The difference is that they are editted by the user at the time of the observation. A `preset` has predefined `keys` and a predefined `values`, while a `tag` has predefined `keys` and user editted values. This is useful when there are descriptors that cannot be predetermined.
 
 Using the bridge example:
 
@@ -57,16 +57,16 @@ const tags = {
 
 ### How to determine the fields associated with a preset
 
-`Presets` have a `fieldsId` property of type `string[]`. For each value in the array, there is an associated field with a matching `docId`.
+`Presets` have a `fieldsId` property of type `string[]`. For each value in the array, there is an associated field with a matching docId.
 
 Each observation can have a several fields associated with it.
 
-Each field has a `type`, where `type: "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";`. This defines how the field is presented to the user, and how the user inputs the value of the field. If the type is `text` or `number` the user inputs a string or number. If the type is `selectOne` or `selectMultiple` the user is given a list of options to select from which determines the value of the field.
+Each field has a `type`, where `type: "text" | "number" | "selectOne" | "selectMultiple" | "UNRECOGNIZED";`. This defines how the field is presented to the user,and how the user inputs the value of the field. If the type is `text` or `number` the user inputs a string or number. If the type is `selectOne` or `selectMultiple` the user types is given a list of options to select from which determines the value of the field
 
-A field has a `tagKey` property. This defines the `key` of the tag saved in the observation.
+A field has a `tagKey` property. This defined the `key` of the tag saved in the observation
 
 ### Flow for saving an observation
 
-1. User chooses a preset. This preset has `tags` and `fieldIds`.
-2. Based on the `fieldIds` the user is prompted to fill in several forms. This provides another `tags` object where the `keys=Field['tagKeys']` and the value is the value inputted by the user.
-3. The tags from the preset and the tags from the fields are flattened into the `tags` object of an observation.
+1. User choses a preset. This preset has `tags` and `fieldIds`.
+2. Based on the `fieldIds` the user is prompted to fill in several forms. This provides an another `tags` object where the `keys=Field['tagKeys']` and the value is the value inputted by the user.
+3. The tags from the preset, and the tags from the fields are flattened into `tags` object of an observation.

messages/en.json

@@ -350,6 +350,18 @@
     "description": "Title of observation screen showing (non-editable) view of observation with map and answered questions",
     "message": "Observation"
   },
+  "screens.ObservationDetails.done": {
+    "description": "Button text when all questions are complete",
+    "message": "Done"
+  },
+  "screens.ObservationDetails.nextQuestion": {
+    "description": "Button text to navigate to next question",
+    "message": "Next"
+  },
+  "screens.ObservationDetails.title": {
+    "description": "Title of observation details screen showing question number and total",
+    "message": "Question {current} of {total}"
+  },
   "screens.ObservationEdit.BottomSheet.addLabel": {
     "description": "Label above keyboard that expands into bottom sheet of options to add (photo, details etc)",
     "message": "Add…"
@@ -358,6 +370,10 @@
     "description": "Placeholder for description/notes field",
     "message": "What is happening here?"
   },
+  "screens.ObservationEdit.ObservationEditView.detailsButton": {
+    "description": "Button label to add details",
+    "message": "Add Details"
+  },
   "screens.ObservationEdit.ObservationEditView.photoButton": {
     "description": "Button label for adding photo",
     "message": "Add Photo"

package.json

@@ -30,7 +30,7 @@
     "@formatjs/intl-pluralrules": "^5.2.4",
     "@formatjs/intl-relativetimeformat": "^11.2.4",
     "@gorhom/bottom-sheet": "^4.5.1",
-    "@mapeo/ipc": "0.3.0",
+    "@mapeo/ipc": "^0.4.0",
     "@osm_borders/maritime_10000m": "^1.1.0",
     "@react-native-community/hooks": "^2.8.0",
     "@react-native-community/netinfo": "11.1.0",
@@ -95,7 +95,7 @@
     "@babel/preset-env": "^7.20.0",
     "@babel/runtime": "^7.20.0",
     "@formatjs/cli": "^6.2.0",
-    "@mapeo/core": "9.0.0-alpha.7",
+    "@mapeo/core": "^9.0.0-alpha.8",
     "@mapeo/schema": "3.0.0-next.15",
     "@react-native-community/cli": "^12.3.6",
     "@react-native/babel-preset": "^0.73.21",

scripts/build-backend.mjs

@@ -74,6 +74,7 @@ const KEEP_THESE = [
   'loader.js',
   // Static folders referenced by @mapeo/core code
   'node_modules/@mapeo/core/drizzle',
+  'node_modules/@mapeo/default-config'
 ];
 
 for (const name of KEEP_THESE) {

src/backend/index.js

@@ -10,6 +10,11 @@ const MIGRATIONS_FOLDER_PATH = new URL(
   import.meta.url,
 ).pathname
 
+const DEFAULT_CONFIG_PATH = new URL(
+  './node_modules/@mapeo/default-config/dist/mapeo-default-config.mapeoconfig',
+  import.meta.url,
+).pathname
+
 try {
   const { values } = parseArgs({
     options: {
@@ -35,6 +40,7 @@ try {
     rootKey: Buffer.from(values.rootKey, 'hex'),
     migrationsFolderPath: MIGRATIONS_FOLDER_PATH,
     sharedStoragePath: values.sharedStoragePath,
+    defaultConfigPath: DEFAULT_CONFIG_PATH,
   }).catch((err) => {
     console.error('Server startup error:', err)
   })