open-index/open-npm huggingface dataset:
npm package: @gtsc/api-auth-entity-storage
Description: Perform REST authentication using entity storage
Author: martyn.janes@iota.org
Latest version: 0.0.3-next.36

# GTSC Auth Entity Storage

Perform REST authentication using entity storage.

## Installation

```shell
npm install @gtsc/api-auth-entity-storage
```

## Examples

Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

## Reference

Detailed reference documentation for the API can be found in [docs/reference/globals.md](docs/reference/globals.md)

## Changelog

The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
npm package: @gtsc/api-core
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.22

# api-core

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build api-core` to build the library.

## Running unit tests

Run `nx test api-core` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/api-fastify
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.23

# api-fastify

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build api-fastify` to build the library.

## Running unit tests

Run `nx test api-fastify` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/api-models
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.23

# api-models

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build api-models` to build the library.

## Running unit tests

Run `nx test api-models` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-auditable-item-graph
Description: Store items and their associated data, and provide an immutable audit trail for the item. Includes relationships between the items to form a graph.
Latest version: 0.0.23

# building-block-auditable-item-graph

Store items and their associated data, and provide an immutable audit trail for the item. Includes relationships between the items to form a graph.

### Features
- Create/update/retrieve data for an item
  - Properties
  - Primary Identifier
  - Secondary Identifiers (alternative IDs that can be used to find the item e.g. associated document IDs)
  - Relationships to other items (parent/child/inherits)
  - Resources associated with the item(documents, data feeds)
- Store the hash of the item data in immutable storage
- Complete immutable audit trail of all the changes to the item
- Search for the item by its primary or secondary identifiers


### Extensions
- Blobs - create/update binary items resources (e.g. documents)
- JSON-LD - readable version of the item for interoperability


### Use Cases
- Store the data for a consignment with associated documents
- Store the data for an item, related to a parent consignment and inheriting a product type


## Building

This library was generated with [Nx](https://nx.dev).

Run `nx build building-block-auditable-item-graph` to build the library.

## Running unit tests

Run `nx test building-block-auditable-item-graph` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-authentication
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.1.19

# building-block-authentication

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-authentication` to build the library.

## Running unit tests

Run `nx test building-block-authentication` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-data-extraction
Description: Documents have many varying formats, the data extraction building block extracts the data from the documents and returns it in a known structured format.
Latest version: 0.0.24

# building-block-data-extraction

Documents have many varying formats, the data extraction building block extracts the data from the documents and returns it in a known structured format.

### Features
- Create/Update document templates which define where data is located in a document type and what fields this maps to in a known structured format
- Given a document can extract the data and return the content in the known format
- Support XML/JSON document format

### Extensions
- OCR data extraction
- Pdf data extraction

### Use Cases
- Cross border UI to display data aggregated from many documents
- Interoperability with other systems that want to consume the data from our framework

## Building

This library was generated with [Nx](https://nx.dev).

Run `nx build building-block-data-extraction` to build the library.

## Running unit tests

Run `nx test building-block-data-extraction` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-data-types
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.11

# building-block-data-types

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-data-types` to build the library.

## Running unit tests

Run `nx test building-block-data-types` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-document-management
Description: Building block to provide a simple mechanism for storing and verifying documents, with optional association as a resource to existing items.
Latest version: 0.0.25

# building-block-document-management

Building block to provide a simple mechanism for storing and verifying documents, with optional association as a resource to existing items.

### Features
- Add a document
- Store the hash of the document and the DID of the entity adding the document
- Retrieve a document and verify its authenticity and author

### Use Cases
- Adding a phyto-sanitary certificate to a consignment
- Associating a certificate of provenance with an item
- Creating a verifiable purchase order for sharing

## Building

This library was generated with [Nx](https://nx.dev).

Run `nx build building-block-document-management` to build the library.

## Running unit tests

Run `nx test building-block-document-management` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-identity
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.21

# building-block-identity

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-identity` to build the library.

## Running unit tests

Run `nx test building-block-identity` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-indexing
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.24

# building-block-indexing

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-indexing` to build the library.

## Running unit tests

Run `nx test building-block-indexing` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-logger
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.23

# building-block-logger

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-logger` to build the library.

## Running unit tests

Run `nx test building-block-logger` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-mocks
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.25

# building-block-mocks

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build building-block-mocks` to build the library.

## Running unit tests

Run `nx test building-block-mocks` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/building-block-simple-event-repository
Description: Record events for an item, events could be status updates, EPCIS events, location events etc . The events will be stored immutably.
Latest version: 0.0.23

# building-block-simple-event-repository

Record events for an item, events could be status updates, EPCIS events, location events etc . The events will be stored immutably.

### Features
- Create/update events associated with an item
- Hash the events and create an immutable record for them
- Retrieve timeline of current events

### Extensions
- JSON-LD read endpoint

### Use Cases
- Record documents requests, location changes etc for a consignment


## Building

This library was generated with [Nx](https://nx.dev).

Run `nx build building-block-simple-event-repository` to build the library.

## Running unit tests

Run `nx test building-block-simple-event-repository` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/dlt-iota
Description: DLT helpers for use with IOTA
Author: martyn.janes@iota.org
Latest version: 0.0.5-next.1

# GTSC DLT IOTA

DLT helpers for use with IOTA.

## Installation

```shell
npm install @gtsc/dlt-iota
```

## Examples

Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

## Reference

Detailed reference documentation for the API can be found in [docs/reference/globals.md](docs/reference/globals.md)

## Changelog

The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
npm package: @gtsc/framework
Description: Framework packages for GTSC
Author: martyn.janes@iota.org
Latest version: 0.0.1

# GTSC / Framework

This repository contains some of the fundamental packages that the rest of the GTSC packages depend on. There are lots of utility functions and helper classes.

## Packages

- [nameof-transformer](./packages/nameof-transformer/README.md) - A TypeScript transformer which converts types and properties to their actual name for use at runtime.
- [nameof](./packages/nameof/README.md) - Provides the definitions for the methods which are processed by the `nameof-transformer`
- [core](./packages/core/README.md) - Helper methods/classes for data type checking/validation/guarding/error handling.
- [entity](./packages/entity/README.md) - Helpers for defining and working with entities.
npm package: @gtsc/framework-api
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.13

# framework-api

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build framework-api` to build the library.

## Running unit tests

Run `nx test framework-api` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/framework-core
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.15

# framework-core

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build framework-core` to build the library.

## Running unit tests

Run `nx test framework-core` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/framework-crypto
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.8

# framework-crypto

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build framework-crypto` to build the library.

## Running unit tests

Run `nx test framework-crypto` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @gtsc/framework-services
Description: This library was generated with [Nx](https://nx.dev).
Latest version: 0.0.13

# framework-services

This library was generated with [Nx](https://nx.dev).

## Building

Run `nx build framework-services` to build the library.

## Running unit tests

Run `nx test framework-services` to execute the unit tests via [Jest](https://jestjs.io).