{"id":34527626,"url":"https://github.com/eclipse-xfsc/data-exchange-logging","last_synced_at":"2026-04-18T16:39:29.228Z","repository":{"id":289913243,"uuid":"963958513","full_name":"eclipse-xfsc/data-exchange-logging","owner":"eclipse-xfsc","description":"The XFSC Service Data Exchange Logging Service (GX-DELS) provides evidence that data has been (a) submitted and (b) received and (c) rules and obligations (Data Usage Policies) were enforced or violated","archived":false,"fork":false,"pushed_at":"2025-04-25T17:35:21.000Z","size":4859,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-25T18:39:33.857Z","etag":null,"topics":["data-exchange","nodejs","policy"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipse-xfsc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-10T13:25:38.000Z","updated_at":"2025-04-25T17:33:20.000Z","dependencies_parsed_at":"2025-04-25T18:51:43.758Z","dependency_job_id":null,"html_url":"https://github.com/eclipse-xfsc/data-exchange-logging","commit_stats":null,"previous_names":["eclipse-xfsc/data-exchange-logging"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eclipse-xfsc/data-exchange-logging","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-exchange-logging","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-exchange-logging/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-exchange-logging/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-exchange-logging/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-xfsc","download_url":"https://codeload.github.com/eclipse-xfsc/data-exchange-logging/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-xfsc%2Fdata-exchange-logging/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31976801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T16:27:12.723Z","status":"ssl_error","status_checked_at":"2026-04-18T16:27:11.140Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-exchange","nodejs","policy"],"created_at":"2025-12-24T05:24:13.056Z","updated_at":"2026-04-18T16:39:29.220Z","avatar_url":"https://github.com/eclipse-xfsc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Open Items:\n\n- AbstractCAMAdapter needs to be implemented\n\n```\n/**\n*  The GX-DELS MUST provide a mechanism to enforce the integrity of the overall Log Entry storage. The GX-DELS MUST provide a possibility to verify the integrity in regular intervals by the GX-CAM (see above in GX-DLES.IR.010).\n*/\nreportCorruptedLog(notification: InboxNotification): Promise\u003cvoid\u003e;\n```\n\n## Installation\n\n```bash\n$ npm config set @gaia-x:registry https://gitlab.com/api/v4/projects/38989724/packages/npm/\n$ npm install\n```\n\n## Formatting\n\n```bash\n# Setting the hooksPath will run the pre-commit hook in order to standardize the formatted output\n$ git config core.hooksPath .github/hooks\n```\n\n## Running the app\n\n#### Environment variables - example ./.env.example\n\n```\n# general\nNODE_ENV=development # development/production\nNX_API_ENDPOINT=/api # api server endpoint\n\n# server\nSERVER_ENDPOINT=http://localhost:3000 # endpoint for current application\nSERVER_THROTLLER_TTL=60\nSERVER_THROTLLER_LIMIT=10\n\n#logger\n## types \"console\"/\"winston\"\nLOGGER_TYPE=console\n# winston config\nLOGGER_WINSTON_LEVEL=info\nLOGGER_WINSTON_TRANSPORTS_CONSOLE=true\nLOGGER_WINSTON_TRANSPORTS_FILE=logs/app.log\n# cache\n## types \"memory\"/\"redis\"\nCACHE_TYPE=redis\nCACHE_TTL=300\n\n# db\nDATABASE_HOST=127.0.0.1\nDATABASE_PORT=5432\nDATABASE_USER=postgres\nDATABASE_PASSWORD=mysecretpassword\nDATABASE_DATABASE=dels\n\n## redis config\nREDIS_HOST=localhost\nREDIS_PORT=6379\nREDIS_PREFIX=cache\n\n# admin config\nADMIN_USERNAME=admin\nADMIN_PASSWORD=admin\nADMIN_JWT_SECRET_KEY=dafgsdfgsdfgasdfasdf\nADMIN_JWT_EXPIRES_IN_MINUTES=120\nBACKUP_LOCATION=/tmp/backups\nBACKUP_CRON=*/1 * * * *\n\n# admin settings - used to seed default settings\nSETTING_LOG_RETENTION_PERIOD_DAYS=30\nSETTING_LOG_PRUNING_CRON=*/1 * * * *\nSETTING_LOG_INTEGRITY_CRON=*/1 * * * *\n\n# gateways\nTRUST_SERVICE_GATEWAY_HOST=https://trust-service.com\nCAM_GATEWAY_HOST=http://example.com\nDCT_GATEWAY_HOST=http://dct-service.com\n```\n\n#### Config variables - example ./apps/api/.env.example\n\nNOTE: `\"./apps/api/.env\"` - overrides `\"./.env\"`\n\nRequired\n\n- ADMIN_USERNAME - username used to sign into Administrative UI\n- ADMIN_PASSWORD - password used to sign into Administrative UI\n- ADMIN_JWT_SECRET_KEY - secret key used to generate JWT token\n\nOptional\n\n- SERVER_THROTLLER_TTL - number\n- SERVER_THROTLLER_LIMIT - number\n\n- ADMIN_JWT_EXPIRES_IN_MINUTES - number\n- LOGGER_TYPE - \"console\"/\"winston\"\n- LOGGER_WINSTON_LEVEL\n- LOGGER_WINSTON_TRANSPORTS_CONSOLE - boolean\n- LOGGER_WINSTON_TRANSPORTS_FILE - file path\n- CACHE_TYPE - \"memory\"/\"redis\"\n- CACHE_TTL - number\n- SETTING_LOG_RETENTION_PERIOD_DAYS - number\n- SETTING_LOG_PRUNING_CRON\n- SETTING_LOG_INTEGRITY_CRON\n\n```bash\n# development (watch mode)\n$ npm run start:dev\n\n# production mode\n$ npm run start\n```\n\n## Pre Deploy\n\n```bash\n$ npm run typeorm:migrations:generate ${migration_name}\n$ npm run typeorm:migrations:run\n```\n\n## DB Migrations\n\n##### Revert\n\n```bash\n$ npm run typeorm:migrations:revert\n```\n\n##### Create new empty migration\n\n```bash\n$ npm run typeorm:migrations:create ./apps/api/src/migrations/${migration_name}\n```\n\n## Swagger path (OpenApi spec):\n\n- `/swagger`\n\n## Docker\n\nMinimum envrionment config `\"./.env.example\"`, rename it to `\".env\"`\n\n```bash\n$ docker-compose up\n```\n\n## Test\n\n```bash\n# unit tests\n$ npm run test\n\n# e2e tests\n$ npm run test:e2e\n\n# test coverage\n$ npm run test:cov\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-xfsc%2Fdata-exchange-logging","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-xfsc%2Fdata-exchange-logging","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-xfsc%2Fdata-exchange-logging/lists"}