@overture-stack/lectern-client

Lectern Client

The Lectern Client provides developers TypeScript code tools to interact with Lectern servers and Lectern Dictionaries. This package provides data processing functions that will parse and validate submitted data, ensuring that it adheres to the structure defined by the Dictionary. It also provides a REST client to fetch Lectern Dictionary data from a Lectern Server.

Features

• REST client to interact with Lectern servers:
  • Fetch dictionary by name and version
  • Fetch difference summaries between dictionary versions
• Process data using a Lectern Dictionary:
  • Convert raw string inputs into properly typed values.
  • Check the structure of input data is valid.
  • Apply all restrictions, both across schemas and on individual fields, to validate input data.
  • Report all validation errors found in the input data.
• Lectern Validation library functionality:
  • Parsing functions to check and convert data types from string values
  • Validation functions to confirm the structure and content of records match Lectern schemas
  • This functionality is combined in the Processing functions
• Create template for TSV and CSV files based on a Lectern Schema

Developer Examples

Data Fetching

Data fetching from a lectern service can be perfromed through the rest module:

import * as lectern from '@overture-stack/lectern-client';

const lecternUrl = 'http://lectern.example.com';
const dictionaryName = 'my-example-schemas';
const dictionaryVersion = '2.3';

const allAvailableDictionariesResult = await lectern.rest.listDictionaries(lecternUrl);
const filteredByNameDictionariesResult = await lectern.rest.listDictionaries(lecternUrl, { name: dictionaryName });

const exampleDicionaryResult = await lectern.rest.getDictionary(lecternUrl, {
	name: dictionaryName,
	version: dictionaryVersion,
});

if (exampleDicionaryResult.success) {
	// use the data:
	console.log(JSON.stringify(exampleDicionaryResult.data));
}

Responses from the rest calls will be Result objects. Before using the data, check that exampleDicionaryResult.success is true, and if so, you can get the fully typed response data in exampleDicionaryResult.data.

Data Processing

The following example shows how to process data using the Lectern Client. The input donorData is presented as hardcoded, but in a typical scenario this would be submitted to the application through an uploaded TSV, form entry, or similar user submission system.

To process data records which all belong to the same schema we use the processSchema function:

import * as lectern from '@overture-stack/lectern-client';
import type { Dictionary } from '@overture-stack/lectern-client';


const dictionary: Dictionary; // You will need to provide or fetch the dictionary

const donorData = [{submitter_donor_id: "abc123", gender: "Male", age: "28"}, {submitter_donor_id: "def456", gender: "Female", age: "37"}]

const schemaProcessingResult = lectern.process.processSchema(dictionary, "donors", donorData);

switch (schemaProcessingResult.status) {
	case 'SUCCESS': {
		const { records } = schemaProcessingResult;
		// use converted and validated records
	}
	case 'ERROR_PARSING': {
		const {  errors, records } = schemaProcessingResult;
		// errors occured parsing records. read the errors that occurred
		// records have been return with their values parsed where possible. If an error occurred, the original input string value is returned
	}
	case 'ERROR_VALIDATION': {
		const { records, errors } = schemaProcessingResult;
		// errors occured validating records. these errors have been returned
		// records were parsed successfully, so this returns all parsed records
	}

Data File Templates

The function createDataFileTemplate can be used to create the content of a TSV or CSV formatted template file, based on the fields in a Lectern Schema. This file content includes a header row with all field names for the schema, and a blank row with delimeters for each field. Also provided is a filename for the file, which is the schema name and the appropriate file extension for the TSV or CSV.

This template file can be used to collect data for validation using Lectern.

This function does not produce an actual file or any file system interaction or download, just the expected content and filename.

import * as lectern from '@overture-stack/lectern-client';
import type { Schema } from '@overture-stack/lectern-client';


const schema: Schema; // You will need to provide or fetch a dictionary schema

const dataFileTemplate = lectern.createDataFileTemplate(schema); // tsv by default

const tsvFileContent = dataFileTemplate.content;
const tsvFileName = dataFileTemplate.filename;

Example with CSV file:

// specify csv
const csvFileTemplate = lectern.createDataFileTemplate(schema, { fileType: 'csv' });

Custom delimiter:

// txt file with | as delimiter
const customFileTemplate = lectern.createDataFileTemplate(schema, { delimiter: '|', extension: 'txt' }); 

Lectern Dependencies

The Lectern Client is a wrapper around Lectern submodules that allow functionality to be shared between client and server implementations. If you do not need the REST client, or the combined processing functions, you can consider including submodules directly to access the specific pieces of functionality you require.

Package	Description
lectern-dictionary	Definition of the Lectern Dictionary structure. Includes TS types and schemas for validating the content of Lectern dictionary. Also includes functionality to comparing multiple Lectern Dictionary versions, and to analyze the differences between them.
lectern-validation	Provides functionality for validating data against a Lectern dictionary.