Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add conditional restrictions to dictionary fields #198

Closed
wants to merge 11 commits into from
Closed

Add conditional restrictions to dictionary fields #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9d9464f
Create client package and copy files from js-lectern-client
joneubank May 26, 2024
f4c421e
Use rimraf in build scripts for cross platform compatibility
joneubank May 26, 2024
c47fab9
Target ESNext for internal library builds
joneubank May 26, 2024
d91f4d6
Update copyright year of copied client files to 2024
joneubank May 26, 2024
0ff65f7
Proposed dictionary structure with conditional restrictions
joneubank Apr 21, 2024
30ee009
Add `count` restriction, and types to conditions table
joneubank Apr 22, 2024
e359eaa
Separate dictionary types into smaller files
joneubank Apr 26, 2024
713bbe4
Separate tests for dictionaryTypes into smaller files
joneubank Apr 26, 2024
de7a57e
Example dictionary with name that passes validation (no spaces or '.'
joneubank May 24, 2024
cbe0f7a
Compare restriction relations, remove RangeRestriction from case prop…
joneubank May 24, 2024
58f5b0e
Dictionary docs describe nested meta and restrictions as arrays
joneubank May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ The modules in the monorepo are organized into three categories:
* __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.

| 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](https://github.com/overture-stack/js-lectern-client) | Package | @overture-stack/js-lectern-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. |
| 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. |

## Developer Instructions
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/dictionaryRoutes.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ describe('Dictionary Routes', () => {
});

it('Should get a single dictionary by name and version', (done: Mocha.Done) => {
const name = 'Test Dictionary';
const name = 'test_dictionary';
chai
.request(app)
.get(`/dictionaries/?name=${name}&version=${testVersion}`)
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createDictionary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Test Dictionary",
"name": "test_dictionary",
"version": "1.2",
"schemas": [
{
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createKeyValue.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Key Value Meta",
"name": "key_value_meta",
"version": "1.0",
"references": {
"enums": {
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createKeyValueBad.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Key Value Meta",
"name": "key_value_meta",
"version": "1.1",
"schemas": [
{
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createKeyValueBadReferenceFormat.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Key Value Meta",
"name": "key_value_meta",
"version": "1.0",
"references": {
"enums": {
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createKeyValueBadReferenceValueType.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Key Value Meta",
"name": "key_value_meta",
"version": "1.0",
"references": {
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion apps/server/test/integration/fixtures/createKeyValueBadUnknownReference.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Key Value Meta",
"name": "key_value_meta",
"version": "1.0",
"references": {
"enums": {
Expand Down
7 changes: 5 additions & 2 deletions libraries/common/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@
"main": "dist/index.js",
"scripts": {
"build": "pnpm build:clean && tsc",
"build:clean": "rm -rf dist/ && mkdir dist"
"build:clean": "rimraf -rf dist/ && mkdir dist"
},
"keywords": [],
"author": "Ontario Institute for Cancer Research",
"license": "AGPL-3.0"
"license": "AGPL-3.0",
"devDependencies": {
"rimraf": "^3.0.2"
}
}
2 changes: 1 addition & 1 deletion libraries/common/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "ES5",
"target": "ESNext",
"lib": ["ESNext"],
"module": "CommonJS",
"moduleResolution": "node",
Expand Down
Loading