Releases: bcgsc/pori_graphkb_schema
Releases · bcgsc/pori_graphkb_schema
Release v4.1.1
Bugfix
- Fix Statement's displayNameTemplate generation when default template is used
v4.1.0
Improvements
- [KBDEV-1197] Add ClinicalTrial.active index #25; #32
- [KBDEV-1360] Add evidence level and preclinical warning to Statement sentence display #30
- [KBDEV-1381] Add GH action triggers for npm-test.yml #28
v4.0.0
Breaking Changes
- No longer using classes for ClassDefinition and PropertyDefinition, see migration guide in the README (and below)
Migration Guide: v3 to v4
To facilitate more reuseable typing schemes ClassModel and Property classes have been removed and now are simply objects. All interactions with these models should go through the schema class instead of interacting directly with the model and property objects. Return types are given only when they differ.
| v3 | v4 equivalent |
|---|---|
ClassModel._properties |
ClassDefinition.properties |
ClassModel.properties |
SchemaDefinition.getProperties(modelName: string) |
ClassModel.required |
SchemaDefinition.requiredProperties(modelName: string) |
ClassModel.optional |
SchemaDefinition.optionalProperties(modelName: string) |
ClassModel.getActiveProperties() |
SchemaDefinition.activeProperties(modelName: string) |
ClassModel.inherits |
SchemaDefinition.ancestors(modelName: string) |
ClassModel.subclasses: ClassModel[] |
SchemaDefinition.children(modelName: string): string[] |
ClassModel.descendantTree(excludeAbstract: boolean): ClassModel[] |
SchemaDefinition.descendants(modelName: string, opt: { excludeAbstract?: boolean, includeSelf?: boolean }): string[] 1 |
ClassModel.queryProperties: Record<string,Property[]> |
SchemaDefinition.queryableProperties(modelName: string): Record<string,PropertyDefinition[]> |
ClassModel.inheritsProperty(propName: string) |
SchemaDefinition.inheritsProperty(modelName: string, propName: string) |
ClassModel.toJSON |
N/A 2 |
ClassModel.formatRecord(record: GraphRecord, opt = {}) |
SchemaDefinition.formatRecord(modelName: string, record: GraphRecord, opt = {}) |
Property.validate(inputValue: unknown): unknown |
validateProperty = (prop: PropertyDefinition, inputValue: unknown): unknown |
v3.16.0
v3.15.1
v3.15.0
v3.15.0
BugFixes
- bcgsc/pori_graphkb_parser#5 Add support for five-prime cds mutations
Note: Minor release since it requires a corresponding migration update in the API