Release 2.0.0-beta.1

overture-stack · Aug 30, 2024 · c99b726 · c99b726
2 parents 0595bb5 + fc4fd77
commit c99b726
Show file tree

Hide file tree

Showing 271 changed files with 14,746 additions and 2,306 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -3,7 +3,6 @@
 
 # Allow select paths
 !apps/*
-!libraries/*
 !packages/*
 !package.json
 !pnpm-lock.yaml

diff --git a/Jenkinsfile b/Jenkinsfile
@@ -0,0 +1,3 @@
+@Library(value='jenkins-pipeline-library@master', changelog=false) _
+pipelineOVERTURELectern()
+
diff --git a/Jenkinsfile.groovy b/Jenkinsfile.groovy
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # Lectern - Data Dictionary Management and Validation
 
-[<img hspace="5" src="https://img.shields.io/badge/chat--with--developers-slack-blue?style=for-the-badge">](http://slack.overture.bio)
+[<img hspace="5" src="https://img.shields.io/badge/chat--with--developers-overture--slack-blue?style=for-the-badge">](http://slack.overture.bio)
 [<img hspace="5" src="https://img.shields.io/badge/License-AGPL--3.0-blue?style=for-the-badge">](https://github.com/overture-stack/lectern/blob/develop/LICENSE)
-[<img hspace="5" src="https://img.shields.io/badge/Code%20of%20Conduct-2.1-blue?style=for-the-badge">](CODE_OF_CONDUCT.md)
+[<img hspace="5" src="https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge">](CODE_OF_CONDUCT.md)
 
 
 Lectern is Overture's Data Dictionary Schema Manager, providing a system for defining Schemas that will validate the structured data collected by an application. The core of Lectern is a web-server application that handles storage and version management of data dictionaries. Lectern data dictionaries are collections of  schemas that define the structure of tabular data files (like TSV). This application provides functionality to validate the structure of data dictionaries, maintain a list of dictionary versions, and to compute the difference between dictionary versions.
@@ -23,45 +23,58 @@ The repository is organized with the following directory structure:
 .
 ├── apps/
 │   └── server 
-├── libraries/
-│   ├── common
-│   └── dictionary
 └── packages/
-    └── client
+    ├── client
+    ├── common
+    ├── dictionary
+    └── validation
 ```
 
-The modules in the monorepo are organized into three categories:
+The modules in the monorepo are organized into two categories:
 
    * __apps/__ - Standalone processes meant to be run. These are published to [ghcr.io](https://ghcr.io) as container images.
-   * __libraries/__ - Interal modules shared between other apps, libraries, and packages.
-   * __packages/__ - Packages published to [NPM](https://npmjs.com) meant to be imported into other TypeScript applications.
+   * __packages/__ - Reusable packages shared between applications and other packages. Packages are published to [NPM](https://npmjs.com).
+   * __scripts__ - Utility scripts for use within this repo.
 
-| Component                           | Type        | Package Name                   | Path                  | Published Location                                                       | Description                                                                                   |
-| ----------------------------------- | ----------- | ------------------------------ | --------------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
-| [Lectern Server](apps/server/README.md)       | Application | server                         | apps/server/          | [GHCR](https://github.com/overture-stack/lectern/pkgs/container/lectern) | Lectern Server web application.                                                               |
-| [Lectern Client](packages/client/README.md)  | Package     | @overture-stack/lectern-client | packages/client       | [NPM](https://www.npmjs.com/package/@overturebio-stack/lectern-client)   | TypeScript Client to interact with Lectern Server and perform data validation.                           |
-| [common](libraries/common/README.md) | Library     | common                     | libraries/common/ | N/A                                                                      | Non-specific but commonly reusable utilities. Includes shared Error classes. |
-| [dictionary](libraries/dictionary/README.md) | Library     | dictionary                     | libraries/dictionary/ | N/A                                                                      | Dictionary meta-schema definition, includes TS types, and Zod schemas. This also exports all utilities for getting the diff of two dictionaries, and for validating data records with a Dictionary. |
+| Component                                           | Package Name                       | Path                               | Published Location                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                       |
+| --------------------------------------------------- | ---------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Lectern Server](apps/server/README.md)             | @overture-stack/lectern-server     | apps/server/                       | [![Lectern GHCR Packages](https://img.shields.io/badge/GHCR-lectern-brightgreen?style=for-the-badge&logo=github)](https://github.com/overture-stack/lectern/pkgs/container/lectern)                             | Lectern Server web application.                                                                                                                                                                                                                                                                   |
+| [Lectern Client](packages/client/README.md)         | @overture-stack/lectern-client     | packages/client                    | [![Lectern Client NPM Package](https://img.shields.io/npm/v/@overture-stack/lectern-client?color=%23cb3837&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@overture-stack/lectern-client)         | TypeScript Client to interact with Lectern Server and Lectern data dictionaries. This library provides a REST client to assist in fetching data from the Lectern server. It also exposes the functionality from the Lectern Validation library to use a Lectern data dictionary to validate data. |
+| [Lectern Dictionary](packages/dictionary/README.md) |                                    | @overture-stack/lectern-dictionary | [![Lectern Client NPM Package](https://img.shields.io/npm/v/@overture-stack/lectern-dictionary?color=%23cb3837&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@overture-stack/lectern-dictionary) | Dictionary meta-schema definition, includes TS types, and Zod schemas. This also exports all utilities for getting the diff of two dictionaries.                                                                                                                                                  |
+| [Lectern Validation](packages/validation/README.md) | @overture-stack/lectern-validation | packages/validation/               | [![Lectern Validation NPM Package](https://img.shields.io/npm/v/@overture-stack/lectern-validation?color=%23cb3837&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@overture-stack/lectern-client)     | Validate data using Lectern Dictionaries.                                                                                                                                                                                                                                                         |
 
 ## Developer Instructions
 
 You can install all dependencies for the entire repo from the root (as defined  the `pnpm-lock.yaml`) with the command:
 
 `pnpm install`
 
-Using `nx` will ensure all local dependencies are built, in the correct sequence, when building, running, or testing any of the applications and packages in the repo. To run a package.json script from any module - after installing dependencies - use a command of the form `pnpm nx <script> <package name>`. For example, to `build` the module `server` can be done with the command:
+Using `nx` will ensure all local dependencies are built, in the correct sequence, when building, running, or testing any of the applications and packages in the repo. To run a package.json script from any module - after installing dependencies - use a command of the form `pnpm nx <script> <package name>`. For example, to `build` the server module `@overture-stack/lectern-server` can be done with the command:
 
-`pnpm nx build server`
+`pnpm nx build @overture-stack/lectern-server`
 
 This will ensure that all dependencies of `server` are built in correct order before the `server` build is run.
 
-To work with any module in this repository, follow the instructions in the README provide in the module directory.
+Note that the full name of from the package must be used for this to work, so for the client the command would be:
+
+`pnpm nx build @overture-stack/lectern-client`
+
+For convenience, scripts have been added to the root level [`package.json`](./package.json) to run `build` and `test` scripts for every service using short names. These follow the pattern `pnpm <build|test>:<package short name/alias>`. For example,  the same build command can be performed by:
+
+`pnpm build:client`
+
+To work with any module in this repository, follow the instructions in the README provide in that module's directory.
 
 Get started by running the [Lecter Server application](apps/server/README.md).
 
 ### Common Commands
 
 A few commonly reused scripts have been added to the root `package.json`. Run them from the root directory, or if you are in a sub directory then use `pnpm -w`.
+
+For example, when your current working directory is not in the project root, you can still conveniently test every module in the monorepo with the command:
+
+`pnpm -w test:all`
+
 #### Build Everything
 
 `pnpm build:all`
@@ -72,30 +85,26 @@ This will build all modules.
 
 `pnpm test:all`
 
-This will test everything, building all dependencies needed to fully test.
+This will test all modules in the repo.
 
-## Additonal Content
+## Additional Content
 
 In addition to the code for Lectern, this repository contains some useful reference material.
 
 ### Meta-Schema
 
 Lectern provides a meta-schema definition that describes the structure of Lectern Dictionaries. The generated JSON Schema formatted copy of this schema can be found at [`./generated/DictionaryMetaSchema.json`](./generated/DictionaryMetaSchema.json).
 
-This can be used as a programing language agnostic schema for external applications that want to validate, generate, or interact with Lectern Dictionaries.
+This can be used as a programing language agnostic schema for external applications to validate Lectern Dictionaries.
 
-> **Note:**
+> [!NOTE]
 >
 > Don't manually update any files in the `./generated` path. This content is programatically generated from the source code.
 
-### Sample Dictionaries
-
-
-
 ## Support & Contributions
 
 We welcome community contributions! Please follow our [code of conduct](./code_of_conduct.md)
 
 - Filing an [issue](https://github.com/overture-stack/ego/issues)
 - Connect with us on [Slack](http://slack.overture.bio)
-- Add or Upvote a [feature request](https://github.com/overture-stack/ego/issues?q=is%3Aopen+is%3Aissue+label%3Anew-feature)
+- Add or Upvote a [feature request](https://github.com/overture-stack/ego/issues?q=is%3Aopen+is%3Aissue+label%3Anew-feature)
diff --git a/apps/server/Dockerfile b/apps/server/Dockerfile
@@ -25,7 +25,7 @@ RUN chown -R ${APP_USER}:${APP_USER} $(npm config get prefix)
 USER ${APP_USER}:${APP_USER}
 
 RUN pnpm install --ignore-scripts
-RUN pnpm nx build server
+RUN pnpm nx build @overture-stack/lectern-server
 
 EXPOSE 3000
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		@Library(value='jenkins-pipeline-library@master', changelog=false) _
		pipelineOVERTURELectern()