@gtsc/building-block-auditable-item-graph

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.

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.