@cyberismo/assets 0.0.8 → 0.0.9

package/src/calculations/common/utils.lp

@@ -0,0 +1,230 @@
+% Utils extends the cyberismo query language
+
+% policy checks
+selectCollectionField("successes", "title").
+selectCollectionField("successes", "category").
+selectCollectionField("failures", "title").
+selectCollectionField("failures", "category").
+selectCollectionField("failures", "errorMessage").
+selectCollectionField("failures", "fieldName").
+
+childObject(Card, (Card, "policyChecks"), "policyChecks") :-
+    showField(Card, "policyChecks").
+
+childResultCollection((Card, "policyChecks"), "successes") :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks").
+
+childResultCollection((Card, "policyChecks"), "failures") :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks").
+
+% successes
+childResult((Card, "policyChecks"), (Card, Category, Title), "successes") :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    policyCheckSuccess(Card, Category, Title).
+
+fields((Card, Category, Title), "category", Category, "title", Title) :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    policyCheckSuccess(Card, Category, Title).
+
+% failures
+
+% add empty field for failures with no field
+policyCheckFailure(Card, Category, Title, ErrorMessage, "") :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    policyCheckFailure(Card, Category, Title, ErrorMessage).
+
+childResult((Card, "policyChecks"), (Card, Category, Title, ErrorMessage, Field), "failures") :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    policyCheckFailure(Card, Category, Title, ErrorMessage, Field).
+
+fields((Card, Category, Title, ErrorMessage, Field), "category", Category, "title", Title, "errorMessage", ErrorMessage) :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    policyCheckFailure(Card, Category, Title, ErrorMessage, Field).
+
+field((Card, Category, Title, ErrorMessage, Field), "fieldName", Field) :-
+    childObject(Card, (Card, "policyChecks"), "policyChecks"),
+    Field != "",
+    policyCheckFailure(Card, Category, Title, ErrorMessage, Field).
+
+
+
+% links
+selectCollectionField("links", "displayName").
+selectCollectionField("links", "linkDescription").
+selectCollectionField("links", "direction").
+selectCollectionField("links", "linkType").
+selectCollectionField("links", "displayName").
+selectCollectionField("links", "linkSource").
+selectCollectionField("links", "title").
+selectCollectionField("links", "key").
+
+childResultCollection(Card, "links") :-
+    showField(Card, "links").
+
+childResult(Card, (Card, Destination, LinkType, "", "outbound"), "links") :-
+    link(Card, Destination, LinkType),
+    showField(Card, "links").
+
+childResult(Card, (Card, Destination, LinkType, LinkDescription, "outbound"), "links") :-
+    link(Card, Destination, LinkType, LinkDescription),
+    showField(Card, "links").
+
+childResult(Card, (Source, Card, LinkType, "", "inbound"), "links") :-
+    link(Source, Card, LinkType),
+    showField(Card, "links").
+
+childResult(Card, (Source, Card, LinkType, LinkDescription, "inbound"), "links") :-
+    link(Source, Card, LinkType, LinkDescription),
+    showField(Card, "links").
+
+% links: displayName
+field((Source, Destination, LinkType, LinkDescription, Direction), "displayName", DisplayName, "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    Direction = "outbound",
+    field(LinkType, "outboundDisplayName", DisplayName).
+
+field((Source, Destination, LinkType, LinkDescription, Direction), "displayName", DisplayName, "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    Direction = "inbound",
+    field(LinkType, "inboundDisplayName", DisplayName).
+
+% links: link description
+field((Source, Destination, LinkType, LinkDescription, Direction), "linkDescription", LinkDescription, "shortText") :-
+    LinkDescription != "",
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links").
+
+% links: direction and link type
+fields((Source, Destination, LinkType, LinkDescription, Direction), "direction", Direction, "linkType", LinkType) :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links").
+
+% links: link source
+
+field((Source, Destination, LinkType, LinkDescription, Direction), "linkSource", "user", "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    userLink(Source, Destination, LinkType).
+
+field((Source, Destination, LinkType, LinkDescription, Direction), "linkSource", "user", "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    userLink(Source, Destination, LinkType, LinkDescription).
+
+field((Source, Destination, LinkType, LinkDescription, Direction), "linkSource", "calculated", "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    calculatedLink(Source, Destination, LinkType).
+
+field((Source, Destination, LinkType, LinkDescription, Direction), "linkSource", "calculated", "shortText") :-
+    childResult(_, (Source, Destination, LinkType, LinkDescription, Direction), "links"),
+    calculatedLink(Source, Destination, LinkType, LinkDescription).
+
+% links: title
+field((Card, Destination, LinkType, LinkDescription, Direction), "title", Title, "shortText") :-
+    childResult(Card, (Card, Destination, LinkType, LinkDescription, Direction), "links"),
+    field(Destination, "title", Title).
+
+field((Source, Card, LinkType, LinkDescription, Direction), "title", Title, "shortText") :-
+    childResult(Card, (Source, Card, LinkType, LinkDescription, Direction), "links"),
+    field(Source, "title", Title).
+
+% links: key
+field((Card, Destination, LinkType, LinkDescription, Direction), "key", Destination, "shortText") :-
+    childResult(Card, (Card, Destination, LinkType, LinkDescription, Direction), "links").
+
+field((Source, Card, LinkType, LinkDescription, Direction), "key", Source, "shortText") :-
+    childResult(Card, (Source, Card, LinkType, LinkDescription, Direction), "links"),
+    field(Source, "title", Title).
+
+
+% notifications
+select(2, "notifications", "title").
+select(2, "notifications", "category").
+select(2, "notifications", "message").
+
+childResultCollection(Card, "notifications") :-
+    showField(Card, "notifications").
+
+% notifications
+childResult(Card, (Card, Category, Title, Message), "notifications") :-
+    showField(Card, "notifications"),
+    notification(Card, Category, Title, Message).
+
+fields((Card, Category, Title, Message), "key", Card, "category", Category, "title", Title) :-
+    childResult(Card, (Card, Category, Title, Message), "notifications").
+
+field((Card, Category, Title, Message), "message", Message) :-
+    childResult(Card, (Card, Category, Title, Message), "notifications").
+
+
+% denied operations
+selectCollectionField("transition", "transitionName").
+selectCollectionField("transition", "errorMessage").
+selectCollectionField("move", "errorMessage").
+selectCollectionField("delete", "errorMessage").
+selectCollectionField("editField", "fieldName").
+selectCollectionField("editField", "errorMessage").
+selectCollectionField("editContent", "errorMessage").
+
+childObject(Card, (Card, "deniedOperations"), "deniedOperations") :-
+    showField(Card, "deniedOperations").
+
+% transition denied operations
+childResultCollection((Card, "deniedOperations"), "transition") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations").
+
+childResult((Card, "deniedOperations"), (Card, TransitionName, ErrorMessage), "transition") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations"),
+    transitionDenied(Card, TransitionName, ErrorMessage).
+
+fields((Card, TransitionName, ErrorMessage), "transitionName", TransitionName, "errorMessage", ErrorMessage) :-
+    childResult((Card, "deniedOperations"), (Card, TransitionName, ErrorMessage), "transition").
+
+% move denied operations
+childResultCollection((Card, "deniedOperations"), "move") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations").
+
+childResult((Card, "deniedOperations"), (Card, ErrorMessage), "move") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations"),
+    movingCardDenied(Card, ErrorMessage).
+
+field((Card, ErrorMessage), "errorMessage", ErrorMessage) :-
+    childResult((Card, "deniedOperations"), (Card, ErrorMessage), "move").
+
+% delete denied operations
+childResultCollection((Card, "deniedOperations"), "delete") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations").
+
+childResult((Card, "deniedOperations"), (Card, ErrorMessage), "delete") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations"),
+    deletingCardDenied(Card, ErrorMessage).
+
+field((Card, ErrorMessage), "errorMessage", ErrorMessage) :-
+    childResult((Card, "deniedOperations"), (Card, ErrorMessage), "delete").
+
+% editField denied operations
+childResultCollection((Card, "deniedOperations"), "editField") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations").
+
+childResult((Card, "deniedOperations"), (Card, FieldName, ErrorMessage), "editField") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations"),
+    editingFieldDenied(Card, FieldName, ErrorMessage).
+
+fields((Card, FieldName, ErrorMessage), "fieldName", FieldName, "errorMessage", ErrorMessage) :-
+    childResult((Card, "deniedOperations"), (Card, FieldName, ErrorMessage), "editField").
+
+% editContent denied operations
+childResultCollection((Card, "deniedOperations"), "editContent") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations").
+
+childResult((Card, "deniedOperations"), (Card, ErrorMessage), "editContent") :-
+    childObject(Card, (Card, "deniedOperations"), "deniedOperations"),
+    editingContentDenied(Card, ErrorMessage).
+
+field((Card, ErrorMessage), "errorMessage", ErrorMessage) :-
+    childResult((Card, "deniedOperations"), (Card, ErrorMessage), "editContent").
+
+
+% labels
+childResultCollection(Card, "labels") :-
+    showField(Card, "labels").
+
+field(Card, "labels", Label, "stringList") :-
+    showField(Card, "labels"),
+    label(Card, Label).

package/src/calculations/queries/card.lp

@@ -6,108 +6,131 @@ result(X) :- projectCard(X).
 
 % a helper term for display names
 
-displayName(Card, Field, DisplayName) :-
+displayName(Card, (Card, Field), DisplayName) :-
     field(Card, Field, _),
     fieldType(Field),
     field(Field, "displayName", DisplayName),
     field(Card, "cardType", CardType),
     not field((CardType, Field), "displayName", _).
 
-displayName(Card, Field, DisplayName) :-
+displayName(Card, (Card, Field), DisplayName) :-
     field(Card, "cardType", CardType),
+    fieldType(Field),
     field((CardType, Field), "displayName", DisplayName).
 
 % the second level includes metadata for the always visible and optionally visible fields
+% we include the card key in the key of the fields, because the same query is used
+% when generating static sites for all project cards at the same time
 
-field(Field, "visibility", "always") :-
+field((Card, Field), "key", Field) :-
+    customField(CardType, Field),
+    field(Card, "cardType", CardType),
+    result(Card).
+
+field((Card, Field), "visibility", "always") :-
     alwaysVisibleField(CardType, Field),
     field(Card, "cardType", CardType),
     result(Card).
 
-field(Field, "visibility", "optional") :-
+field((Card, Field), "visibility", "optional") :-
     optionallyVisibleField(CardType, Field),
     field(Card, "cardType", CardType),
     result(Card).
 
-field(Field, "index", Index) :-
+field((Card, Field), "index", Index) :-
     alwaysVisibleField(CardType, Field),
     field((CardType, Field), "index", Index),
     field(Card, "cardType", CardType),
     result(Card).
 
-field(Field, "index", Index) :-
+field((Card, Field), "index", Index) :-
     optionallyVisibleField(CardType, Field),
     field((CardType, Field), "index", Index),
     field(Card, "cardType", CardType),
     result(Card).
 
-dataType(Field, "fieldDisplayName", "shortText") :-
-    childResult(_, Field, "fields"),
-    field(Field, "fieldDisplayName", _).
+field((Card, Field), "fieldDisplayName", DisplayName, "shortText") :-
+    childResult(Card, (Card, Field), "fields"),
+    result(Card),
+    displayName(Card, (Card, Field), DisplayName).
 
-field(Field, "fieldDisplayName", DisplayName) :-
-    childResult(_, Field, "fields"),
+field((Card, Field), "fieldDescription", Description, "shortText") :-
+    childResult(Card, (Card, Field), "fields"),
     result(Card),
-    displayName(Card, Field, DisplayName).
+    field(Field, "description", Description).
 
-dataType(Field, "isCalculated", "boolean") :-
-    childResult(_, Field, "fields"),
-    field(Field, "isCalculated", _).
+dataType((Card, Field), "isCalculated", "boolean") :-
+    childResult(Card, (Card, Field), "fields"),
+    field((Card, Field), "isCalculated", _).
 
-field(Field, "isCalculated", true) :-
+field((Card, Field), "isCalculated", true) :-
     result(Card),
     field(Card, "cardType", CardType),
     calculatedField(CardType, Field).
 
-field(Field, "isCalculated", false) :-
-    childResult(_, Field, "fields"),
+field((Card, Field), "isCalculated", false) :-
+    childResult(Card, (Card, Field), "fields"),
     result(Card),
     field(Card, "cardType", CardType),
     not calculatedField(CardType, Field).
 
-
-
+% add dataType of field
+field((Card, Field), "dataType", DataType, "shortText") :-
+    childResult(Card, (Card, Field), "fields"),
+    result(Card),
+    field(Field, "dataType", DataType).
 
 % add value
-dataType(Field, "value", DataType) :-
-    childResult(_, Field, "fields"),
+dataType((Card, Field), "value", DataType) :-
+    childResult(Card, (Card, Field), "fields"),
     result(Card),
     field(Card, Field, Value),
     dataType(Card, Field, DataType).
 
-
 % add value
-field(Field, "value", Value) :-
-    childResult(Card, Field, "fields"),
+field((Card, Field), "value", Value) :-
+    childResult(Card, (Card, Field), "fields"),
     field(Card, Field, Value).
 
+% add cardTypeDisplayName
+field(Card, "cardTypeDisplayName", DisplayName, "shortText") :-
+    result(Card),
+    field(Card, "cardType", CardType),
+    field(CardType, "displayName", DisplayName).
 
 % select only non-custom fields
 select(1, "cardType").
+select(1, "cardTypeDisplayName").
 select(1, "title").
 select(1, "key").
 select(1, "lastUpdated").
 select(1, "workflowState").
-select(1, "notifications").
 select(1, "policyChecks").
 select(1, "links").
+select(1, "notifications").
 select(1, "deniedOperations").
 select(1, "labels").
 
-select(2, "visibility").
-select(2, "index").
-select(2, "fieldDisplayName").
-select(2, "fieldDescription").
-select(2, "dataType").
-select(2, "isCalculated").
-select(2, "value").
+% Fields
 
-childResult(Card, Field, "fields") :-
+select(2, "fields", "key").
+select(2, "fields", "visibility").
+select(2, "fields", "index").
+select(2, "fields", "fieldDisplayName").
+select(2, "fields", "fieldDescription").
+select(2, "fields", "dataType").
+select(2, "fields", "isCalculated").
+select(2, "fields", "value").
+
+childResultCollection(Card, "fields") :-
+    result(Card).
+
+childResult(Card, (Card, Field), "fields") :-
     alwaysVisibleField(CardType, Field),
     field(Card, "cardType", CardType),
     result(Card).
 
-childResult(Card, Field, "fields") :-
+childResult(Card, (Card, Field), "fields") :-
     optionallyVisibleField(CardType, Field),
     field(Card, "cardType", CardType),
     result(Card).
@@ -118,8 +141,9 @@ select(3, "enumDisplayValue").
 select(3, "enumDescription").
 select(3, "enumValue").
 
-childResult(Field, (Field, EnumValue), "enumValues") :-
-    enumValue(Field, EnumValue).
+childResult((Card, Field), (Field, EnumValue), "enumValues") :-
+    enumValue(Field, EnumValue),
+    childResult(Card, (Card, Field), "fields").
 
 field((Field, EnumValue), "enumValue", EnumValue) :-
     enumValue(Field, EnumValue).

package/src/exportPdfReport/index.adoc.hbs

@@ -0,0 +1,33 @@
+= {{title}}
+{{name}}
+:doctype: book
+:toc: macro
+:numbered:
+:imagesdir: images
+:revnumber: {{version}}
+:revdate: {{date}}
+:revremark: {{revremark}}
+:!chapter-signifier:
+:source-highlighter: rouge
+:toclevels: 5
++
+toc::[]
+{{#each results}}
+  {{#include}}
+     "cardKey": "{{this.key}}",
+     "levelOffset": "{{this.levelOffset}}",
+     "title": "only"
+  {{/include}}
+[horizontal]
+  {{#each this}}
+  {{#if (isCustomField @key)}}
+  {{@key}}:: {{formatValue this}}
+  {{/if}}
+  {{/each}}
+{{#include}}
+    "cardKey": "{{this.key}}",
+    "levelOffset": "{{this.levelOffset}}",
+    "title": "exclude",
+    "pageTitles": "discrete"
+{{/include}}
+{{/each}}

package/src/exportPdfReport/query.lp.hbs

@@ -0,0 +1,47 @@
+{{#if cardKey}}
+result({{cardKey}}).
+
+{{#if recursive}}
+result(Card) :- parent(Card, Parent), result(Parent).
+{{/if}}
+
+{{else}}
+result(Card) :- projectCard(Card), not hiddenInTreeView(Card).
+{{/if}}
+
+% Calculate depth levels
+cardLevel(Card, 1) :- result(Card), not parent(Card, _).
+cardLevel(Card, Level + 1) :- 
+    cardLevel(Parent, Level), 
+    parent(Card, Parent), 
+    result(Card).
+
+% Create a path-based ordering system using string concatenation
+% For each card, create a path that represents its position in the tree
+% Root cards: just their rank (already lexicographically sortable)
+% Child cards: parent's path + "!" + own rank
+
+% Base case: root cards use their rank directly as the path
+treePath(Card, Rank) :- 
+    cardLevel(Card, 1),
+    result(Card),
+    field(Card, "rank", Rank).
+
+% Recursive case: children append their rank to parent's path
+treePath(Card, FullPath) :-
+    cardLevel(Card, Level),
+    Level > 1,
+    parent(Card, Parent),
+    treePath(Parent, ParentPath),
+    field(Card, "rank", Rank),
+    result(Card),
+    FullPath = @concatenate(ParentPath, "!", Rank).
+
+% Sort by tree path (lexicographic ordering will give us depth-first)
+order(1, "results", 1, "treePath", "ASC").
+
+selectAll.
+
+% Map level to levelOffset and add tree path for sorting
+field(Card, "levelOffset", Level) :- cardLevel(Card, Level), result(Card).
+field(Card, "treePath", Path) :- treePath(Card, Path), result(Card).

package/src/graphvizReport/query.lp.hbs

@@ -100,6 +100,7 @@ field(((node, Node), Field), "value", Value) :-
     attr(node, Node, Field, Value),
     not labelAttribute(Field).
 
+% default graph
 graph(default) :-
     node(_).
 
@@ -112,8 +113,8 @@ node(X, default) :-
 edge((XR, YR), default) :-
     edge((XR, YR)).
 
-edge((XR, YR, ""), Graph) :-
-    edge((XR, YR), Graph).
+edge((XR, YR, Identifier), default) :-
+    edge((XR, YR, Identifier)).
 
 % edges
 childResult(Graph, (edge, (XR, YR, Description)), "edges") :-
@@ -138,4 +139,11 @@ field((edge, (XR, YR, Description)), "source", XR) :-
 field((edge, (XR, YR, Description)), "destination", YR) :-
     edge((XR, YR, Description), _).
 
+% edges without a separate identifier use "" as their identifier
+edge((XR, YR, ""), Graph) :-
+    edge((XR, YR), Graph).
+
+attr(edge, (Source, Destination, ""), Attribute, Value) :-
+  attr(edge, (Source, Destination), Attribute, Value).
+
 order(N, Collection, 1, "rank", "ASC") :- resultLevel(_, N, Collection).

package/src/index.ts

@@ -4,24 +4,33 @@ export * from './schemas.js';
 // They rarely change and we get 100% type safety this way
 import commonBase from './calculations/common/base.lp';
 import commonQueryLanguage from './calculations/common/queryLanguage.lp';
+import commonUtils from './calculations/common/utils.lp';
 import queriesCard from './calculations/queries/card.lp';
 import queriesOnCreation from './calculations/queries/onCreation.lp';
 import queriesOnTransition from './calculations/queries/onTransition.lp';
 import queriesTree from './calculations/queries/tree.lp';
 import testModel from './calculations/test/model.lp';
 
-import graphvizReportQuery from './graphvizReport/query.lp.hbs';
+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';
 
 export const graphvizReport = {
   query: graphvizReportQuery,
   content: graphvizReportIndex,
 };
 
+export const pdfReport = {
+  query: pdfReportQuery,
+  content: pdfReportIndex,
+};
+
 export const lpFiles = {
   common: {
     base: commonBase,
     queryLanguage: commonQueryLanguage,
+    utils: commonUtils,
   },
   queries: {
     card: queriesCard,

package/src/schema/macros/imageMacroSchema.json

@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "$id": "imageMacroSchema",
+  "properties": {
+    "fileName": {
+      "type": "string",
+      "description": "The filename of the image attachment to display"
+    },
+    "cardKey": {
+      "type": "string",
+      "description": "The key of the card containing the image attachment. If not specified, uses the current card"
+    },
+    "alt": {
+      "type": "string",
+      "description": "Alternative text for the image"
+    },
+    "title": {
+      "type": "string",
+      "description": "Title attribute for the image"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["fileName"]
+}

package/src/schema/macros/includeMacroSchema.json

@@ -0,0 +1,26 @@
+{
+  "type": "object",
+  "$id": "includeMacroSchema",
+  "properties": {
+    "cardKey": {
+      "type": "string",
+      "description": "The key of the card to include content from"
+    },
+    "levelOffset": {
+      "type": "string",
+      "description": "Optional offset to adjust the heading levels of the included content. Should be a number as string (e.g., '+1', '+2' or '-1')."
+    },
+    "title": {
+      "type": "enum",
+      "description": "Whether to include the title of the card in the included content. If 'only' is selected, the title will be the only content included.",
+      "enum": ["include", "exclude", "only"]
+    },
+    "pageTitles": {
+      "type": "enum",
+      "description": "If discrete, page titles will be included as discrete headings(read asciidoctor docs for more info). If normal, page titles will be included as normal headings.",
+      "enum": ["normal", "discrete"]
+    }
+  },
+  "additionalProperties": false,
+  "required": ["cardKey"]
+}

package/src/schema/macros/percentageMacroSchema.json

@@ -0,0 +1,25 @@
+{
+  "type": "object",
+  "$id": "percentageMacroSchema",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Title text on top of the widget"
+    },
+    "value": {
+      "type": "number",
+      "description": "Percentage value (0-100)"
+    },
+    "legend": {
+      "type": "string",
+      "description": "Description text shown below the value"
+    },
+    "colour": {
+      "type": "string",
+      "enum": ["blue", "green", "yellow", "red", "orange", "purple"],
+      "description": "Colour of the progress arc (optional)"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["title", "value", "legend"]
+}