@gisatcz/ptr-be-core 0.0.1-dev.1 → 0.0.1-dev.3

package/src/panther/SharedFeature.md

@@ -1,43 +0,0 @@
-# Panther Models and Logic
-Panther models are based on graph data structure. Graph structure is flat and very flexible. 
-
-## What are Graphs
-Graph can be visualiset as dots connected by lines. 
-
-Graphs have two parts: 
-- node (dot)
-- edge (line)
-
-Nodes are connected by Edges into a graph. 
-
-## Node Structure
-Node has two main parts:
-- Label(s)
-- Properties
-
-### Labels
-Label is one or more Tags that define a "category" saing "What this Node is". 
-Examples are Place, Period, Datasource etc.
-
-Combination of multiple nodes can be used as multiple-level labeling. Like `[Datasource, WMS]` is combination of two labels for single node.
-
-### Properties
-Can be anything inside the node. Can be `key`, `name` or any general property we need.
-
-## Edge Structure
-Edge is connection betwee two nodes. Can be directed (from-to). 
-
-Same as Nodes, Edge also can have:
-- Label(s)
-- Properties
-
-Works the same as in the node case. 
-
-Example of Edge Labels: `IS_RELATED`, `WAITING_FOR`, `CONTAINS`
-Example of Edge properties: `expiration`, `length`, `priority`, `created`
-
-## Resources
-Please check resorces for visual explanation and many other examples.
-
-- https://neo4j.com/docs/getting-started/graph-database/
-- https://www.mongodb.com/resources/basics/databases/mongodb-graph-database

package/src/panther/enums.panther.ts

@@ -1,41 +0,0 @@
-/**
- * What types of graph nodes we use in metadata model
- */
-export enum UsedNodeLabels {
-    Application = "application", // Application node (the root of the FE app)
-    Datasource = "datasource", // Datasource node for data including GIS information
-    Place = "place", // Place node for geographical information
-    Period = "period", // Period node for time information
-    AreaTree = "areaTree", // Area tree node for administrative division
-    AreaTreeLevel = "areaTreeLevel", // Area tree level node for administrative division
-    Layer = "layer", // Layer node for map layer (layer have a style and a datasource)
-    Style = "style", // Style node for map layer or a feature
-    Feature = "feature" // Feature node for map layer
-}
-
-/**
- * What datasources we use in the system
- */
-export enum UsedDatasourceLabels {
-    Attribute = "attribute",   // Column(s) with attribute values
-    Geojson = "geojson",      // Geojson for web map
-    WMS = "wms",              // WMS online source
-    COG = "cogBitmap",        // COG online source
-    MVT = "mvt",              // MVT (Mapbox Vector Tiles) source
-    XYZ = "xyz",              // XYZ tile source
-    CSV = "csv",              // CSV data source
-    GeoTIFF = "geotiff",      // GeoTIFF raster data
-    Shapefile = "shapefile",   // ESRI Shapefile format
-    PostGIS = "postgis",      // PostGIS database source
-    WMTS = "wmts",            // Web Map Tile Service
-    WFS = "wfs",              // Web Feature Service
-    GeoPackage = "geopackage" // OGC GeoPackage format
-}
-
-/**
- * What types of edges we use in metadata model
- */
-export enum UsedEdgeLabels {
-    RelatedTo = "RELATED", // Generic edge for any relation
-    Has = "HAS", // Edge for ownership relation
-}

package/src/panther/models.edges.ts

@@ -1,20 +0,0 @@
-import { Nullable } from "../coding/code.types"
-import { UsedEdgeLabels } from "./enums.panther"
-
-/**
- * Tuple for relation between two graph nodes
- * It is point to point definition of graph edge
- */
-export type GraphRelation = [string, string]
-
-
-/**
- * Edge of the graph model.
- * It connects two graph nodes and have some properties.
- * Have "key" witch is composed from node keys.
- */
-export interface GraphEdge{
-    labels: string[] | UsedEdgeLabels[],
-    edgeNodes: GraphRelation
-    properties: Nullable<object>
-}

package/src/panther/models.nodes.properties.ts

@@ -1,31 +0,0 @@
-/**
- * Entity that has relevant time interval.
- * Example: Period is connected to some time range.
- */
-export interface HasInterval {
-    validUtcIntervalIso: string,
-    validFrom: number,
-    validTo: number
-}
-
-/**
- * Entity with custom configuration
- */
-export interface HasConfiguration {
-    configuration: string // JSON string
-}
-
-/**
- * Place node - somewhere in the world
- */
-export interface HasGeometry {
-    geometry: any,
-    bbox: any,
-}
-
-/**
- * Place node - somewhere in the world
- */
-export interface HasLevels {
-    level: number,
-}

package/src/panther/models.nodes.ts

@@ -1,55 +0,0 @@
-import { Nullable } from "../coding/code.types"
-import { HasGeometry, HasInterval, HasLevels, HasConfiguration } from "./models.nodes.properties"
-import { UsedNodeLabels, UsedDatasourceLabels } from "./enums.panther"
-
-/**
- * General graph node - same for all metadatata entities
- */
-export interface PantherEntity {
-    labels: Array<string | UsedNodeLabels | UsedDatasourceLabels>,
-    key: string
-    nameDisplay: string,
-    nameInternal: string,
-    description: Nullable<string>,
-    lastUpdatedAt: number,
-}
-
-/**
- * Place node - somewhere in the world
- */
-export interface Place extends PantherEntity, HasGeometry { }
-
-/**
- * Period node - selected time in timeline
- */
-export interface Period extends PantherEntity, HasInterval { }
-
-/**
- * Area tree node - tree of areas
- */
-export interface AreaTreeLevel extends PantherEntity, HasLevels {}
-
-/**
- * Datasource with source configuration
- */
-export interface Datasource extends PantherEntity, HasConfiguration {}
-
-/**
- * Application node - main entity in metadata model
- */
-export interface ApplicationNode extends PantherEntity, HasConfiguration {}
-
-export { UsedNodeLabels, HasInterval, UsedDatasourceLabels }
-
-
-/**
- * Represents a full panther entity which extends the basic PantherEntity
- * and optionally includes geometry, interval, levels, and configuration properties.
- * 
- * @extends PantherEntity
- * @extends Partial<HasGeometry>
- * @extends Partial<HasInterval>
- * @extends Partial<HasLevels>
- * @extends Partial<HasConfiguration>
- */
-export interface FullPantherEntity extends PantherEntity, Partial<HasGeometry & HasInterval & HasLevels & HasConfiguration> { }

package/tsconfig.json

@@ -1,51 +0,0 @@
-{
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "outDir": "dist",
-    "rootDir": ".",
-    
-    /* Strict Type-Checking Options */
-    "strict": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    
-    /* Module Resolution Options */
-    "esModuleInterop": true,
-    
-    /* Advanced Options */
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    
-    /* Additional Options */
-    "sourceMap": true,
-    "noEmitOnError": true,
-
-    /* Declaration Options */
-    "declaration": true,
-    "declarationMap": true,
-
-    "resolveJsonModule": true,
-    "types": [
-      "node"
-    ],
-    /* Path Mapping (Optional) */
-    "baseUrl": ".",
-    "paths": {
-      "@core/*": ["./src/*"]
-    },
-  },
-  "include": [
-    "./**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "./dist/**/*"
-  ],
-  /* Additional Linting Options */
-  "noUnusedLocals": true,
-  "noUnusedParameters": false // Set to true if applicable
-}