README.md

APP-VALIDATION-TOOL

Table of Contents

• Overview
• Features
  • Document Type Validation
  • Validation Glue
• Repository Structure
• Installation
• Usage
  • Testing
• Documentation

---

Overview

The App Validation Tool is an npm module designed to safeguard the integrity of data published to a triple store, crucial in scenarios involving multiple publishers. It meticulously compares publications against a predefined data blueprint, pinpointing discrepancies and enforcing data structure compliance according to specified standards.

Crafted with Test-Driven Development (TDD) principles at its core, this npm module emphasizes reliability and robustness from the ground up. Developed in TypeScript for enhanced type safety and transpiled to JavaScript for wide-ranging compatibility, it incorporates an extensive suite of Jest tests. This rigorous testing approach ensures the module performs reliably under various scenarios, making it a trustworthy addition to any Node.js project.

Features

Document Type Validation

Publications must meet structural requirements to ensure consistency and readability. The module supports validation for the following document types:

- Besluitenlijst
- Notule
- Agenda

In addition to specific document types, each publication is required to have a title, validated as a string to ensure it is present and correctly formatted. For "Notule" documents, there is an additional requirement to validate the maturity level, ensuring that these documents not only meet structural standards but also adhere to designated maturity criteria, adding a layer of depth to the validation process.

Validation Glue

In order to properly validate an agenda item exists in a publication, we need to know the following:

- Agenda item
  - title
  - resolution
  - vote
  - decision
- Session
  - time
  - governing body

Repository Structure

└── app-validation-tool/
    ├── README.md
    ├── files
    │   └── basic-agenda.ttl
    │   └── decision-list.ttl
    │   └── notulen.ttl
    ├── jest.config.js
    ├── package-lock.json
    ├── package.json
    ├── src
    │   ├── index.ts
    │   ├── queries.ts
    │   ├── tests
    │   ├── examples.ts
    │   └── validation.ts
    ├── tsconfig.json
    ├── tslint.json
    ├── tsup.config.ts
    └── yarn.lock

Installation

From source

1. Clone the app-validation-tool repository:

$ git clone https://github.com/lblod/app-validation-tool

2. Change to the project directory:

$ cd app-validation-tool

3. Install the dependencies:

$ > npm install

From npm

1. Install the module from npm:

$ > npm install app-validation-tool

Usage

To use the module, import it into your project:

import { validatePublication, getBlueprintOfDocumentType, fetchDocument, getExampleOfDocumentType } from 'app-validation-tool/dist';

Then, call the validatePublication function with the publication data to validate:

const blueprint: Bindings[] = await getBlueprintOfDocumentType('Notulen');
const example: Document = getExampleOfDocumentType('Notulen');
const publication: Bindings[] = await fetchDocument(NOTULEN_LINK, PROXY);

const validationResult = await validatePublication(publication, blueprint, example);

The validatePublication function returns an array of subjects. Each subject is structured as follows:

[key: number]: {
  name: string,
  totalCount: number,
  type: string,
  typeName: string,
  url: string,
  usedShape: string,
  validCount: number,
  validatedProperties: {
    [key: number]: {
      name: string,
}

Testing

Run the test suite using the command below:

npm run test

Documentation

Link to the full documentation here.

Return