@cyberismo/assets 0.0.23 → 0.0.24

package/dist/schemas.d.ts

@@ -222,7 +222,7 @@ export declare const schemas: ({
                 properties: {
                     name: {
                         description: string;
-                        type: string;
+                        $ref: string;
                     };
                     displayName: {
                         description: string;
@@ -240,10 +240,6 @@ export declare const schemas: ({
                         description: string;
                         type: string;
                     };
-                    branch: {
-                        description: string;
-                        type: string;
-                    };
                     private: {
                         description: string;
                         type: string;
@@ -256,6 +252,18 @@ export declare const schemas: ({
     required: string[];
     title: string;
     type: string;
+} | {
+    $id: string;
+    $schema: string;
+    additionalProperties: boolean;
+    properties: {
+        code: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+    type: string;
 } | {
     $id: string;
     additionalProperties: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyberismo/assets",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "This package contains static resources",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   "bugs": "https://github.com/CyberismoCom/cyberismo/issues",
   "type": "module",
   "devDependencies": {
-    "esbuild": "^0.27.2",
+    "esbuild": "^0.28.0",
     "esbuild-plugin-import-glob": "^0.1.1"
   },
   "files": [

package/src/exportPdfReport/index.adoc.hbs

@@ -4,13 +4,13 @@
 :toc: macro
 :numbered:
 :imagesdir: images
-:revnumber: {{version}}
-:revdate: {{date}}
-:revremark: {{revremark}}
-:!chapter-signifier:
+{{#if version}}:revnumber: {{version}}
+{{/if}}{{#if date}}:revdate: {{date}}
+{{/if}}{{#if revremark}}:revremark: {{revremark}}
+{{/if}}:!chapter-signifier:
 :source-highlighter: rouge
 :toclevels: 5
-+
+
 toc::[]
 {{#each results}}
   {{#include}}

package/src/index.ts

@@ -12,10 +12,12 @@ import queriesConnectors from './calculations/queries/connectors.lp';
 import queriesTree from './calculations/queries/tree.lp';
 import testModel from './calculations/test/model.lp';
 
-import pdfReportIndex from './exportPdfReport/index.adoc.hbs';
-import pdfReportQuery from './exportPdfReport/query.lp.hbs';
-import graphvizReportIndex from './graphvizReport/index.adoc.hbs';
-import graphvizReportQuery from './graphvizReport/query.lp.hbs';
+import pdfReportIndex from './exportPdfReport/index.adoc.hbs' with { type: 'text' };
+import pdfReportQuery from './exportPdfReport/query.lp.hbs' with { type: 'text' };
+import graphvizReportIndex from './graphvizReport/index.adoc.hbs' with { type: 'text' };
+import graphvizReportQuery from './graphvizReport/query.lp.hbs' with { type: 'text' };
+import workflowGraphModel from './workflowGraph/model.lp' with { type: 'text' };
+import workflowGraphView from './workflowGraph/view.lp.hbs' with { type: 'text' };
 
 export const graphvizReport = {
   query: graphvizReportQuery,
@@ -27,6 +29,11 @@ export const pdfReport = {
   content: pdfReportIndex,
 };
 
+export const workflowGraph = {
+  model: workflowGraphModel,
+  view: workflowGraphView,
+};
+
 export const lpFiles = {
   common: {
     base: commonBase,

package/src/schema/cardsConfigSchema.json

@@ -1,4 +1,13 @@
 {
+  "$defs": {
+    "projectPrefix": {
+      "type": "string",
+      "description": "Project prefix: 3–10 lowercase letters.",
+      "pattern": "^[a-z]+$",
+      "minLength": 3,
+      "maxLength": 10
+    }
+  },
   "$id": "cardsConfigSchema",
   "additionalProperties": false,
   "description": "General configuration settings for the card tree.",
@@ -8,11 +17,8 @@
       "description": "Project schema version"
     },
     "cardKeyPrefix": {
-      "type": "string",
       "description": "The prefix or the fist component of the card key. For example, ABC",
-      "pattern": "^[a-z]+$",
-      "minLength": 3,
-      "maxLength": 10
+      "$ref": "#/$defs/projectPrefix"
     },
     "name": {
       "description": "Project name",
@@ -53,19 +59,19 @@
         "properties": {
           "name": {
             "description": "Module name (project prefix). Must be unique.",
-            "type": "string"
+            "$ref": "#/$defs/projectPrefix"
           },
           "location": {
             "description": "Git remote URL, or relative file reference.",
             "type": "string"
           },
-          "branch": {
-            "description": "If using git remote URL in 'location' defines git branch. If empty, uses repository default branch'.",
-            "type": "string"
-          },
           "private": {
             "description": "If true, the module is private and requires credentials (CYBERISMO_GIT_USER / CYBERISMO_GIT_TOKEN) or SSH. Does not apply for local file modules.",
             "type": "boolean"
+          },
+          "version": {
+            "description": "Semver version or range constraint (e.g., '1.0.0', '^1.0.0', '>=1.2.0 <2.0.0'). When omitted, any version is accepted.",
+            "type": "string"
           }
         },
         "required": ["name", "location"]

package/src/schema/hubSchema.json

@@ -26,7 +26,7 @@
         "properties": {
           "name": {
             "description": "Module name (project prefix). Must be unique globally.",
-            "type": "string"
+            "$ref": "cardsConfigSchema#/$defs/projectPrefix"
           },
           "displayName": {
             "description": "Display name of the module",
@@ -44,10 +44,6 @@
             "description": "URI to the documentation of the module",
             "type": "string"
           },
-          "branch": {
-            "description": "If using git remote URL in 'location' defines git branch. If empty, uses repository default branch'.",
-            "type": "string"
-          },
           "private": {
             "description": "If true, the module is private and requires credentials (CYBERISMO_GIT_USER / CYBERISMO_GIT_TOKEN) or SSH. Does not apply for local file modules.",
             "type": "boolean"

package/src/schema/macros/mermaidMacroSchema.json

@@ -0,0 +1,13 @@
+{
+  "$id": "mermaidMacroSchema",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "code": {
+      "type": "string",
+      "description": "Mermaid diagram definition text"
+    }
+  },
+  "required": ["code"],
+  "type": "object"
+}

package/src/schema/version.json

@@ -1,3 +1,3 @@
 {
-  "schemaVersion": 3
+  "schemaVersion": 4
 }

package/src/schemas.ts

@@ -27,6 +27,7 @@ import hubSchema from './schema/hubSchema.json' with { type: 'json' };
 import imageMacroSchema from './schema/macros/imageMacroSchema.json' with { type: 'json' };
 import includeMacroSchema from './schema/macros/includeMacroSchema.json' with { type: 'json' };
 import linkTypeSchema from './schema/resources/linkTypeSchema.json' with { type: 'json' };
+import mermaidMacroSchema from './schema/macros/mermaidMacroSchema.json' with { type: 'json' };
 import percentageMacroSchema from './schema/macros/percentageMacroSchema.json' with { type: 'json' };
 import reportMacroBaseSchema from './schema/macros/reportMacroBaseSchema.json' with { type: 'json' };
 import reportSchema from './schema/resources/reportSchema.json' with { type: 'json' };
@@ -58,6 +59,7 @@ export const schemas = [
   imageMacroSchema,
   includeMacroSchema,
   linkTypeSchema,
+  mermaidMacroSchema,
   percentageMacroSchema,
   reportMacroBaseSchema,
   reportSchema,

package/src/workflowGraph/model.lp

@@ -0,0 +1,86 @@
+graph(toplevelGraph).
+attr(graph, toplevelGraph, rankdir, "TD").
+
+% the "initial node" from where the card is created
+node("", toplevelGraph) :- workflowState(Workflow, State, _), visible(Workflow).
+
+% Let's add a separate "Any state" for every state that has transitions from "*"
+node(("*", To), toplevelGraph) :-
+    workflowTransition(Workflow, _, "*", To),
+    visible(Workflow).
+
+attr(node, ("*", To), label, @concatenate("<<font point-size='11'> Any state </font>>")) :-
+    workflowTransition(Workflow, _, "*", To),
+    visible(Workflow).
+
+node(State, toplevelGraph) :- workflowState(Workflow, State, _), visible(Workflow).
+
+% Regular state label
+attr(node, State, label, @concatenate("<<font point-size='14'> <b>", State, "</b> </font> <br/> <font point-size='10'>", StateCategory, "</font>>")) :-
+    workflowState(Workflow, State, StateCategory),
+    visible(Workflow),
+    not currentState(State),
+    State != "",
+    State != "*".
+
+% Current state label is rendered larger and underlined to stand out
+attr(node, State, label, @concatenate("<<font point-size='16'> <b><u>", State, "</u></b> </font> <br/> <font point-size='10'>", StateCategory, "</font>>")) :-
+    workflowState(Workflow, State, StateCategory),
+    visible(Workflow),
+    currentState(State),
+    State != "",
+    State != "*".
+
+edge((From, To, Transition), toplevelGraph) :-
+    workflowTransition(Workflow, Transition, From, To),
+    visible(Workflow),
+    From != "*".
+
+attr(edge, (From, To, Transition), label, @concatenate("<<font point-size='10'>", Transition, "</font>>")) :-
+    workflowTransition(Workflow, Transition, From, To),
+    visible(Workflow),
+    From != "*".
+
+edge((("*", To), To, Transition), toplevelGraph) :-
+    workflowTransition(Workflow, Transition, "*", To),
+    visible(Workflow).
+
+attr(edge, (("*", To), To, Transition), label, @concatenate("<<font point-size='10'>", Transition, "</font>>")) :-
+    workflowTransition(Workflow, Transition, "*", To),
+    visible(Workflow).
+
+% margins
+attr(graph, toplevelGraph, pad, "0.1").
+attr(graph, toplevelGraph, nodesep, "0.6").
+attr(graph, toplevelGraph, ranksep, "0.7").
+attr(node, X, margin, "0.15") :- node(X, _).
+attr(graph, X, margin, "8") :- graph(X, _).
+
+% penwidth
+attr(graph, X, penwidth, "1") :- graph(X).
+attr(graph, X, penwidth, "1") :- graph(X, _).
+attr(node, X, penwidth, "1") :- node(X, _), X != "", not currentState(X).
+attr(node, X, penwidth, "3") :- node(X, _), currentState(X).
+attr(node, X, penwidth, "2") :- node(X, _), X = "".
+attr(edge, (X, Y, N), penwidth, "1") :- edge((X, Y, N), _).
+attr(edge, (X, Y, N), arrowsize, "0.8") :- edge((X, Y, N), _).
+
+% shapes of nodes
+attr(node, X, shape, rectangle) :- node(X, _), X != "".
+attr(node, X, shape, circle) :- node(X, _), X = "".
+attr(node, X, style, rounded) :- node(X, _).
+
+% node colours
+attr(node, State, color, "#FF9300") :-
+    workflowState(Workflow, State, "active"),
+    visible(Workflow).
+
+attr(node, State, color, "#37E900") :-
+    workflowState(Workflow, State, "closed"),
+    visible(Workflow).
+
+% fonts
+attr(graph, G, fontname, "helvetica") :- graph(G).
+attr(graph, G, fontname, "helvetica") :- graph(G, _).
+attr(node, N, fontname, "helvetica") :- node(N, _).
+attr(edge, (X, Y, N), fontname, "helvetica") :- edge((X, Y, N), _).

package/src/workflowGraph/view.lp.hbs

@@ -0,0 +1,4 @@
+visible("{{{clingoEscape workflow}}}").
+{{#if currentState}}
+currentState("{{{clingoEscape currentState}}}").
+{{/if}}