@golemio/fypr 0.0.1 → 1.0.0-dev.2304909032

package/LICENSE

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Operátor ICT, a.s.
+
+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.
+
+Source: http://opensource.org/licenses/MIT

package/README.md

@@ -0,0 +1,42 @@
+<div align="center">
+<p>
+    <a href="https://operatorict.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/oict_logo.png" alt="oict" width="100px" height="100px" />
+    </a>
+    <a href="https://golemio.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/golemio_logo.png" alt="golemio" width="100px" height="100px" />
+    </a>
+</p>
+
+<h1>@golemio/fypr</h1>
+
+<p>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/fypr/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/fypr/badges/master/pipeline.svg" alt="pipeline">
+    </a>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/fypr/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/fypr/badges/master/coverage.svg" alt="coverage">
+    </a>
+    <a href="./LICENSE">
+        <img src="https://img.shields.io/npm/l/@golemio/fypr" alt="license">
+    </a>
+</p>
+
+<p>
+    <a href="#installation">Installation</a> · <a href="./docs">Documentation</a> · <a href="https://operator-ict.gitlab.io/golemio/code/modules/fypr">TypeDoc</a>
+</p>
+</div>
+
+This module is intended for use with Golemio services. Refer [here](https://gitlab.com/operator-ict/golemio/code/modules/core/-/blob/master/README.md) for further information on usage, local development and more.
+
+## Installation
+
+The APIs may be unstable. Therefore, we recommend to install this module as an exact version.
+
+```bash
+# Latest version
+npm install --save-exact @golemio/fypr@latest
+
+# Development version
+npm install --save-exact @golemio/fypr@dev
+```

package/db/example/.config.json

@@ -0,0 +1 @@
+{ "schema": "fypr" }

package/db/example/00_clear_test_data.sql

@@ -0,0 +1,7 @@
+-- TODO: Fill in tables to truncate and sequences to restart
+
+-- TRUNCATE
+--     "table1",
+--     "table2";
+
+-- ALTER SEQUENCE table1_id_seq RESTART;

package/db/migrations/postgresql/.config.json

@@ -0,0 +1 @@
+{ "schema": "fypr, public" }

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * as IntegrationEngine from "./integration-engine/index";
+export * as OutputGateway from "./output-gateway/index";
+export * as SchemaDefinitions from "./schema-definitions/index";

package/dist/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaDefinitions = exports.OutputGateway = exports.IntegrationEngine = void 0;
+// Library exports
+exports.IntegrationEngine = __importStar(require("./integration-engine/index"));
+exports.OutputGateway = __importStar(require("./output-gateway/index"));
+exports.SchemaDefinitions = __importStar(require("./schema-definitions/index"));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kBAAkB;AAClB,gFAA+C;AAC/C,wEAA2C;AAC3C,gFAAgD"}

package/dist/integration-engine/index.d.ts

@@ -0,0 +1,2 @@
+import { AbstractWorker } from "@golemio/core/dist/integration-engine/workers";
+export declare const workers: Array<new () => AbstractWorker>;

package/dist/integration-engine/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workers = void 0;
+exports.workers = [
+// TODO
+];
+//# sourceMappingURL=index.js.map

package/dist/integration-engine/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/integration-engine/index.ts"],"names":[],"mappings":";;;AAEa,QAAA,OAAO,GAAoC;AACpD,OAAO;CACV,CAAC"}

package/dist/output-gateway/index.d.ts

@@ -0,0 +1,2 @@
+import { AbstractRouter } from "@golemio/core/dist/helpers/routing/AbstractRouter";
+export declare const routers: AbstractRouter[];

package/dist/output-gateway/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routers = void 0;
+exports.routers = [
+// TODO
+];
+//# sourceMappingURL=index.js.map

package/dist/output-gateway/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/output-gateway/index.ts"],"names":[],"mappings":";;;AAEa,QAAA,OAAO,GAAqB;AACrC,OAAO;CACV,CAAC"}

package/dist/schema-definitions/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/schema-definitions/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// TODO
+exports.default = {};
+//# sourceMappingURL=index.js.map

package/dist/schema-definitions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schema-definitions/index.ts"],"names":[],"mappings":";;AAAA,OAAO;AACP,kBAAe,EAAE,CAAC"}

package/docs/asyncapi.yaml

@@ -0,0 +1,17 @@
+asyncapi: 3.0.0
+
+info:
+    title: FYPR
+    version: 1.0.0
+    description: FYPR
+
+# TODO channels:
+
+# TODO operations:
+
+components:
+    messages:
+        emptyMessage:
+            title: Empty message
+
+    # TODO schemas:

package/docs/implementation_documentation.md

@@ -0,0 +1,100 @@
+# Implementační dokumentace modulu *fypr*
+
+## Záměr
+
+Modul slouží k ukládání a poskytování informací o fyzických informačních prvcích systému Čitelná Praha.
+
+
+
+## Vstupní data
+
+### Data aktivně stahujeme
+
+TODO: Popis dat, jak je pomocí cronu a integration-engine stahujeme. Pokud jsou data stahována z více zdrojů, každý zdroj je popsán zvlášť.
+
+#### *Název datového zdroje*
+
+- zdroj dat
+  - url
+  - paramtery dotazu
+- formát dat
+  - protokol
+  - datový typ
+  - odkaz na validační schéma
+  - příklad vstupních dat
+- (volitelně) vstupní parametry, hlavičky, atd.
+- frekvence stahování
+  - cron definice
+- název rabbitmq fronty
+  - popis / název fronty, která vyvolá proces integrace, ve které je zdroj dat obsažen
+
+
+
+## Zpracování dat / transformace
+
+TODO: Popis transformace a případného obohacení dat. Zaměřeno hlavně na workery a jejich metody.
+
+### *Název workeru*
+
+Stručný popis workeru.
+
+#### *Název metody workeru*
+
+- vstupní rabbitmq fronta
+  - název
+  - parametry
+- (volitelně) závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - název
+  - parametry
+- datové zdroje
+  - výčet datových zdrojů
+- transformace
+  - odkaz na transformaci dat, případně stručný popis tranformace
+- (volitelně) obohacení dat
+  - popis, pokud se data obohacují a jak
+- data modely
+  - výčet datových modelů, kam se data ukládájí
+
+
+
+## Uložení dat
+
+Popis ukládání dat.
+
+### Obecné
+
+- typ databáze
+  - PSQL
+- databázové schéma
+  - TODO: popis tabulek nebo odkaz na obrázek s databázovým schématem
+- retence dat
+  - TODO: popis zachovávání a promazávání dat
+
+### *Název datového modelu*
+
+- schéma a název tabulky / kolekce
+- struktura tabulky / kolekce
+  - odkaz na schéma, případně na migrační skripty
+- ukázka dat
+
+
+
+## Output API
+
+Popis output-api.
+
+### Obecné
+
+-   OpenAPI v3 dokumentace
+    -   zdrojový soubor: [openapi-output.yaml](./openapi-output.yaml)
+    -   rabin: <https://rabin.golemio.cz/pid/docs/openapi/>
+    -   golem: <https://api.golemio.cz/pid/docs/openapi/>
+-   TODO: veřejné / neveřejné endpointy
+    -   api je veřejné nebo neveřejné, případně seznam vežejných a neveřejných endpointů
+
+#### *Název endpointu*
+
+- zdrojové tabulky
+- (volitlně) nestandardní dodatečná transformace
+- (volitelně) nestandardní url a query parametry
+- ukázka dat (pokud není součástí OpenAPI)

package/docs/index.md

@@ -0,0 +1,3 @@
+# @golemio/fypr
+
+This module is intended for use with Golemio services.

package/docs/openapi-output.yaml

@@ -0,0 +1,95 @@
+openapi: 3.0.3
+
+info:
+    title: 🗿 FYPR API
+    description: >-
+        <p>
+            This is a placeholder description that is automatically replaced in the build process, see <a href="https://gitlab.com/operator-ict/golemio/code/vp/output-gateway/-/blob/development/docs/openapi-header.yaml" target="_blank">/vp/output-gateway/docs/openapi-header.yaml</a>.
+        </p>
+    version: 1.0.0
+    contact:
+        name: Golemio Prague Data Platform
+        email: golemio@operatorict.cz
+        url: https://golemio.cz
+
+servers:
+    - url: https://api.golemio.cz
+      description: Main (production) server
+    - url: https://rabin.golemio.cz
+      description: Test (development) server
+
+tags:
+    - name: 🗿 FYPR (v1)
+      description: Data about physical (on-site) information elements of the Legible Prague system in form of an API.
+
+paths:
+    # TODO: Replace status with actual endpoints
+    /status:
+        get:
+            tags:
+                - 🗿 FYPR (v1)
+            responses:
+                "200":
+                    description: OK
+
+components:
+    headers:
+        LastModified:
+            description: Timestamp of the latest resource update.
+            schema:
+                type: string
+                example: "2024-08-12T12:40:30.000Z"
+        CacheControlNoCache:
+            description: Cache control directive for caching proxies
+            schema:
+                type: string
+                example: no-store, no-cache, must-revalidate
+
+    responses:
+        BadRequestError:
+            description: Bad request - invalid query parameters
+            content:
+                application/json:
+                    schema:
+                        type: object
+                        properties:
+                            error_message:
+                                type: string
+                                example: "Bad request"
+                                nullable: false
+                            error_status:
+                                type: integer
+                                example: 400
+                                nullable: false
+                            error_info:
+                                type: string
+                                example: "{...}"
+                                nullable: true
+                        required:
+                            - error_message
+                            - error_status
+
+        UnauthorizedError:
+            description: API key is missing or invalid
+            headers:
+                WWW_Authenticate:
+                    schema:
+                        type: string
+            content:
+                application/json:
+                    schema:
+                        type: object
+                        properties:
+                            error_message:
+                                type: string
+                                example: "Unauthorized. Failed to authenticate user."
+                                nullable: false
+                            error_status:
+                                type: integer
+                                example: 401
+                                nullable: false
+                        required:
+                            - error_message
+                            - error_status
+
+    # TODO schemas:

package/package.json

@@ -1,12 +1,81 @@
 {
-  "name": "@golemio/fypr",
-  "version": "0.0.1",
-  "description": "",
-  "license": "MIT",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+    "name": "@golemio/fypr",
+    "version": "1.0.0-dev.2304909032",
+    "description": "Golemio FYPR Module",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "directories": {
+        "doc": "docs"
+    },
+    "scripts": {
+        "build": "rimraf ./dist && tspc -p ./tsconfig.build.json",
+        "build-minimal": "run-s 'build -- --sourceMap false --declaration false'",
+        "build-watch": "run-s 'build -- --watch --preserveWatchOutput'",
+        "pretest": "golemio import-db-data",
+        "test": "cross-env NODE_ENV='test' TZ='UTC' mocha --exit --check-leaks --timeout 120000 --reporter-option maxDiffSize=0 -r ts-node/register -r tsconfig-paths/register --file 'test/setup.ts' -r dotenv/config 'test/**/*.test.ts'",
+        "test-debug": "run-s 'test -- --inspect-brk=9230'",
+        "apidocs-test": "npm run apidocs-test-output",
+        "apidocs-test-output": "cross-env NODE_ENV=test golemio swagger api-test --oas docs/openapi-output.yaml --script test/api-docs/output-gateway/server.js --config test/api-docs/output-gateway/portman-config.json --filter test/api-docs/output-gateway/portman-filter.json",
+        "code-coverage": "nyc run-s 'test -- -r source-map-support/register'",
+        "format:check-staged": "pretty-quick --staged --pattern '**/*.ts'",
+        "generate-docs": "typedoc --out docs/typedoc src",
+        "lint": "eslint --cache \"{src,test}/**/*.ts\"",
+        "validate-dependencies": "dependency-cruiser --config .dependency-cruiser.js src"
+    },
+    "keywords": [
+        "golemio"
+    ],
+    "author": "Operator ICT, a.s.",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://gitlab.com/operator-ict/golemio/code/modules/fypr"
+    },
+    "engines": {
+        "node": ">=20.0.0",
+        "npm": ">=8.0.0"
+    },
+    "devDependencies": {
+        "@apideck/portman": "^1.26.5",
+        "@commitlint/cli": "^11.0.0",
+        "@commitlint/config-conventional": "^11.0.0",
+        "@golemio/cli": "1.11.0",
+        "@golemio/core": "3.0.2",
+        "@golemio/eslint-config": "1.1.2",
+        "@swc/core": "^1.15.11",
+        "@types/chai": "^5.2.3",
+        "@types/chai-as-promised": "^8.0.2",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^20.12.7",
+        "@types/pg-copy-streams": "^1.2.5",
+        "@types/sinon": "^21.0.0",
+        "@types/supertest": "^2.0.10",
+        "body-parser": "^1.20.3",
+        "body-parser-xml": "^2.0.5",
+        "chai": "^6.2.2",
+        "chai-as-promised": "^8.0.2",
+        "cross-env": "^7.0.3",
+        "dependency-cruiser": "^17.3.7",
+        "dotenv": "^8.2.0",
+        "eslint": "^8.1.1",
+        "husky": "^4.3.7",
+        "mocha": "^11.7.5",
+        "npm-run-all": "^4.1.5",
+        "nyc": "^17.1.0",
+        "prettier": "2.5.1",
+        "pretty-quick": "^3.1.0",
+        "rimraf": "^3.0.2",
+        "sinon": "^21.0.1",
+        "source-map-support": "0.5.21",
+        "supertest": "^7.1.4",
+        "ts-node": "^10.9.2",
+        "ts-patch": "3.3.0",
+        "tsconfig-paths": "^4.2.0",
+        "typedoc": "^0.28.14",
+        "typescript": "5.9.3",
+        "typescript-transform-paths": "^3.5.5"
+    },
+    "peerDependencies": {
+        "@golemio/core": ">=3.0.2"
+    }
 }