@gisatcz/ptr-be-core 0.0.1-dev.5 → 0.0.1-dev.6

package/dist/globals/arrows/models.arrows.d.ts

@@ -0,0 +1,58 @@
+import { UsedDatasourceLabels, UsedEdgeLabels, UsedNodeLabels } from "../panther/enums.panther";
+import { OneOfEdgeProperties } from "../panther/models.edges.properties";
+import { FullPantherEntity } from "../panther/models.nodes";
+/**
+ * Represents a node in the Arrows diagram/model.
+ *
+ * @remarks
+ * This interface describes the minimal and optional data used to render and
+ * identify a node inside an Arrows-based diagram or graph. Fields marked
+ * optional may be omitted when not required by the renderer or business logic.
+ *
+ * @property id - A unique string identifier for the node. Required.
+ * @property caption - An optional human-readable title or label for the node.
+ * @property labels - Labels associated with the node. Can be one of:
+ *   - string[]: plain text labels,
+ *   - UsedNodeLabels[]: typed node label objects (see UsedNodeLabels),
+ *   - UsedDatasourceLabels[]: typed datasource label objects (see UsedDatasourceLabels).
+ *   Labels are typically used for filtering, categorization, or display.
+ * @property properties - Optional arbitrary metadata for the node. Free-form object
+ *   consumed by application logic (e.g., domain attributes, IDs, flags).
+ * @property position - Optional position of the node in diagram coordinate space.
+ *   - x: horizontal coordinate (number)
+ *   - y: vertical coordinate (number)
+ * @property style - Optional rendering/style overrides (e.g., shape, color, CSS classes).
+ *   This is a renderer-specific, free-form object.
+ */
+export interface ArrowsNode {
+    id: string;
+    caption?: string;
+    labels: string[] | UsedNodeLabels[] | UsedDatasourceLabels[];
+    properties: FullPantherEntity;
+    position?: {
+        x: number;
+        y: number;
+    };
+    style?: object;
+}
+/**
+ * Describes a directed edge between two nodes used by the Arrows model.
+ *
+ * The interface captures identity, connectivity, semantic typing and optional
+ * metadata or rendering hints for an edge.
+ *
+ * @property id - Unique identifier for the edge.
+ * @property fromId - Identifier of the source node (edge origin).
+ * @property toId - Identifier of the target node (edge destination).
+ * @property type - Semantic label or type for the edge; can be a free-form string or one of the predefined UsedEdgeLabels.
+ * @property properties - Optional arbitrary metadata for the edge (key/value map) used for domain-specific data.
+ * @property style - Optional presentation/visualization overrides (for example color, width, dash pattern) applied when rendering the edge.
+ */
+export interface ArrowsEdge {
+    id: string;
+    fromId: string;
+    toId: string;
+    type: string | UsedEdgeLabels;
+    properties?: Partial<OneOfEdgeProperties>;
+    style?: object;
+}

package/dist/globals/panther/models.nodes.structure.d.ts

@@ -0,0 +1,43 @@
+import { GraphEdge } from "./models.edges";
+/**
+ * Represents an object that exposes a collection of neighbouring items.
+ *
+ * The `neighbours` array contains zero or more related elements of type `T`.
+ * Implementations should document whether the array is ordered, whether duplicates
+ * are allowed, and whether `null`/`undefined` values may appear. Modifying the array
+ * (e.g. pushing or splicing) mutates the host object and may affect other consumers
+ * that hold a reference to the same instance.
+ *
+ * @typeParam T - The element type stored in the `neighbours` array.
+ * @property neighbours - An array of neighbouring items of type `T`.
+ */
+export interface HasNeighbours<T> {
+    neighbours: T[];
+}
+/**
+ * Represents a construct that exposes a collection of graph connections.
+ *
+ * Implementations provide an array of GraphEdge instances that describe the relationships
+ * (edges) associated with the entity — for example, connections from or to a graph node.
+ *
+ * Remarks:
+ * - The array may be empty to indicate no connections.
+ * - Implementations are responsible for keeping the array consistent when edges are added,
+ *   removed or updated.
+ *
+ * @property edges - The list of GraphEdge objects representing this entity's connections.
+ */
+export interface HasEdges {
+    edges: GraphEdge[];
+}
+/**
+ * Represents a node and its neighbouring nodes.
+ *
+ * @typeParam T - The type of the node and its neighbours.
+ * @property node - The main node, or `null` if not present.
+ * @property neighbours - An array of neighbouring nodes.
+ * @property edges - An array of edges connecting the node to its neighbours.
+ */
+export interface NodeWithNeighbours<T> extends HasNeighbours<T>, HasEdges {
+    node: T;
+}

package/dist/index.browser.d.ts

@@ -5,3 +5,5 @@ export { type EdgeForPostgisLocationProperties, type EdgePropertiesBasic, type O
 export { type GraphEdge, type GraphRelation } from "./globals/panther/models.edges.js";
 export { type HasBands, type HasColor, type HasConfiguration, type HasGeometry, type HasInterval, type HasLevels, type HasSpecificName, type HasUrl, type HasUnits } from "./globals/panther/models.nodes.properties.js";
 export { type Place, type Period, type AreaTreeLevel, type Datasource, type ApplicationNode, type Attribute, type FullPantherEntity, type MapStyle, type PantherEntity } from "./globals/panther/models.nodes.js";
+export { type HasEdges, type HasNeighbours, type NodeWithNeighbours } from "./globals/panther/models.nodes.structure.js";
+export { type ArrowsNode, type ArrowsEdge } from "./globals/arrows/models.arrows.js";

package/dist/index.node.d.ts

@@ -1,10 +1,4 @@
-export { enumCombineValuesToString, enumValuesToArray, enumValuesToString, flattenObject, isInEnum, notEmptyString, randomNumberBetween, removeDuplicitiesFromArray, sortStringArray } from "./globals/coding/code.formating.js";
-export { type Nullable, type Nullish, type Unsure, type UsurePromise } from "./globals/coding/code.types.js";
-export { UsedDatasourceLabels, UsedEdgeLabels, UsedNodeLabels } from "./globals/panther/enums.panther.js";
-export { type GraphEdge, type GraphRelation } from "./globals/panther/models.edges.js";
-export { type EdgeForPostgisLocationProperties, type EdgePropertiesBasic, type OneOfEdgeProperties } from "./globals/panther/models.edges.properties.js";
-export { type HasBands, type HasColor, type HasConfiguration, type HasGeometry, type HasInterval, type HasLevels, type HasSpecificName, type HasUrl, type HasUnits } from "./globals/panther/models.nodes.properties.js";
-export { type Place, type Period, type AreaTreeLevel, type Datasource, type ApplicationNode, type Attribute, type FullPantherEntity, type MapStyle, type PantherEntity } from "./globals/panther/models.nodes.js";
+export * from "./index.browser.js";
 export { messageFromError, InvalidRequestError, AuthorizationError } from "./node/api/errors.api.js";
 export { type ApiEndpointResponse } from "./node/api/models.api.js";
 export { type AppLogOptions } from "./node/logging/logger.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gisatcz/ptr-be-core",
-  "version": "0.0.1-dev.5",
+  "version": "0.0.1-dev.6",
   "description": "Shared core library for PTR BE services",
   "type": "module",
   "files": [