Merge commit 'cf1fb1942129b80c64d841c66eee2cee0d888fb6' as 'packages/lexicon'

Author: bitbeckers

packages/lexicon/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run checks
+        run: npm run check

packages/lexicon/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

packages/lexicon/.npmignore

@@ -0,0 +1,11 @@
+node_modules/
+*.json
+!package.json
+!package-lock.json
+.git/
+.gitignore
+.DS_Store
+*.log
+results/
+bun.lockb
+lexicons/

packages/lexicon/ERD.png

@@ -0,0 +1,62 @@
+@startuml "HypercertERD"
+title "Hypercert ERD"
+
+hide empty fields
+hide empty methods
+hide stereotypes
+
+!define REVIEW_COLOR #FFFACD
+!define ARROW_COLOR #666666
+
+<style>
+document {
+    title {
+        FontSize 24
+        FontStyle bold
+    }
+}
+classDiagram {
+    arrow {
+        LineColor ARROW_COLOR
+        FontColor ARROW_COLOR
+        FontSize 10
+    }
+    .largeBold {
+        FontSize 20
+        FontStyle bold
+    }
+}
+</style>
+
+entity contributors #FFD4A3
+dataclass "impact claim" as claim <<largeBold>> #B4E5D0
+dataclass evidence
+dataclass measurements
+dataclass evaluations
+dataclass contributions
+dataclass location
+dataclass rights
+dataclass "evidence review" as review_evidence #FFFACD
+dataclass "measurement review" as review_measurement #FFFACD
+dataclass "evaluation review" as review_evaluation #FFFACD
+dataclass "contribution review" as review_contribution #FFFACD
+protocol token <<largeBold>> #FFB6C1
+
+evidence --> claim : supports
+measurements --> claim : quantifies
+measurements --> location : located by
+evidence --> location : located by
+evaluations --> evidence : evaluates
+evaluations --> measurements : evaluates
+rights --> claim : defines\nrights for
+claim <-- token : tokenizes
+contributors --> contributions : make
+contributors --> rights : have
+contributions --> claim : contributes to
+review_evidence --> evidence : evaluates
+review_measurement --> measurements : evaluates
+review_evaluation --> evaluations : evaluates
+review_contribution --> contributions : evaluates
+
+@enduml
+

packages/lexicon/ERD.puml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hypercerts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/lexicon/ERD.svg

@@ -0,0 +1,33 @@
+# Makefile for generating PNG and SVG from PlantUML files
+
+# Variables
+PUML_FILES = $(wildcard *.puml)
+PNG_FILES = $(PUML_FILES:.puml=.png)
+SVG_FILES = $(PUML_FILES:.puml=.svg)
+
+# Default target
+.PHONY: all
+all: $(PNG_FILES) $(SVG_FILES)
+
+# Rule to generate PNG from PUML
+%.png: %.puml Makefile
+	@echo "Generating $@ from $<"
+	plantuml -tpng -pipe < $< > $@
+
+# Rule to generate SVG from PUML
+%.svg: %.puml Makefile
+	@echo "Generating $@ from $<"
+	plantuml -tsvg -pipe < $< > $@
+
+.PHONY: clean
+clean:
+	@echo "Cleaning generated PNG and SVG files..."
+	@rm -f $(PNG_FILES) $(SVG_FILES)
+
+.PHONY: help
+help:
+	@echo "Available targets:"
+	@echo "  all    - Generate all PNG and SVG files from PUML files"
+	@echo "  clean  - Remove generated PNG and SVG files"
+	@echo "  help   - Show this help message"
+