Merge branch 'main' into release

Author: justincorrigible

.gitignore

@@ -1,11 +1,13 @@
 lerna-debug.log
 .groovylintrc.json
 .vscode/*.log
+.vscode/launch.json
 
 **/dist
 **/node_modules
 **/.DS_Store
 **/*.env*
 !**/.env.schema
+**/package-lock.json
 
 *.tsbuildinfo

docs/setup.md

@@ -4,7 +4,7 @@
 
 Before you begin, ensure you have the following installed on your system:
 
-- Node.js (v22)
+- Node.js (v22+)
 - [Docker](https://www.docker.com/products/docker-desktop/) (v4.39.0 or higher)
 
 ## Developer Setup

docs/usage/02-arranger-components.md

@@ -10,18 +10,23 @@ Arranger offers its own front-end library of reusable components to facilitate q
 
 ## Configuration Files Overview
 
-Four main configuration files control Arranger, and its components' behaviours:
+As part of our latest work, in order to ensure Arranger v3.0 remains somewhat backawards-compatible and to facilitate the migration process from v2, we've established a temporary way to control the Server and Components' behaviour through files that centralize the way your indexed data is found and displayed.
+This design will change in future versions (with corresponding documentation), to establish a better separation of concerns between front and back-end.
+
+These customizations can be divided into four files as follows:
 
 1. **base.json**: Defines the core settings for the Elasticsearch index (Important for the Arranger Server).
 2. **extended.json**: Specifies all fields and their display names.
 3. **table.json**: Configures the columns displayed in the data table.
 4. **facets.json**: Defines the aggregations (facets) for data exploration and filtering.
 
+(For further reference on these and other available options, please review the [configuration schema](https://github.com/overture-stack/arranger/blob/main/modules/server/configTemplates/configs.json.schema))
+
 <br/>
 
     :::info Configuration File Location
 
-    Templates of these files can be [found in the Arranger repository located here](https://github.com/overture-stack/arranger/tree/develop/modules/server/configTemplates). Active configuration files must be stored in a `configs` folder located within the `app/modules/server/` directory (unless specified otherwise using the `CONFIG_PATH` environment variable).
+    Templates of these files can be [found in the Arranger repository located here](https://github.com/overture-stack/arranger/tree/main/modules/server/configTemplates). Active configuration files must be stored in a `configs` folder located within the `app/modules/server/` directory (unless specified otherwise using the `CONFIG_PATH` environment variable).
 
     :::
 

integration-tests/import/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "integration-tests-import",
 	"dependencies": {
-		"@overture-stack/arranger-components": "*"
+		"@overture-stack/arranger-components": "file:../../modules/components"
 	},
 	"devDependencies": {
 		"jest": "^29.7.0",

integration-tests/server/package.json

@@ -2,7 +2,7 @@
 	"name": "integration-tests-server",
 	"dependencies": {
 		"@elastic/elasticsearch": "^7.17.14",
-		"@overture-stack/arranger-server": "*",
+		"@overture-stack/arranger-server": "file:../../modules/server",
 		"axios": "^1.7.9",
 		"graphql": "^16.6.0",
 		"graphql-tag": "^2.12.6",

integration-tests/server/test/readSearchData.js

@@ -99,7 +99,8 @@ export default ({ api, documentType, gqlPath }) => {
 						},
 					},
 				},
-			});
+			},
+		);
 
 		assert.deepEqual(
 			await api
@@ -141,7 +142,8 @@ export default ({ api, documentType, gqlPath }) => {
 						},
 					},
 				},
-			});
+			},
+		);
 
 		assert.deepEqual(
 			await api
@@ -188,7 +190,8 @@ export default ({ api, documentType, gqlPath }) => {
 						},
 					},
 				},
-			});
+			},
+		);
 
 		assert.deepEqual(
 			await api
@@ -235,7 +238,8 @@ export default ({ api, documentType, gqlPath }) => {
 						},
 					},
 				},
-			});
+			},
+		);
 	});
 
 	test('3.excludes access_denied files', async () => {
@@ -264,7 +268,7 @@ export default ({ api, documentType, gqlPath }) => {
 
 		assert.deepEqual(
 			data?.data?.[documentType]?.hits?.edges?.every((edge) => !edge.node.access_denied),
-			true
+			true,
 		);
 	});
 
@@ -306,9 +310,6 @@ export default ({ api, documentType, gqlPath }) => {
 				console.log('readSearchData error', err);
 			});
 
-		assert.deepEqual(
-			data?.data?.[documentType]?.hits?.edges?.length,
-			0
-		);
+		assert.deepEqual(data?.data?.[documentType]?.hits?.edges?.length, 0);
 	});
 };

modules/components/README.md

@@ -1,9 +1,5 @@
 # Data Portal Components
 
-## Roadmap
+## Developer Experience (WIP)
 
-#### Aggregations
-
-#### SQON aka "Current Filters"
-
-#### ResultsTable
+- use `"preserveSymlinks": true` client-side in tsconfig.json, when implementing locally through `npm link`. This prevent duplicate import of deep dependencies (e.g. @types/react).