@cyberismo/assets 0.0.6

package/src/calculations/queries/onCreation.lp

@@ -0,0 +1,44 @@
+{{#each cardKeys}}
+createdCard({{this}}).
+{{/each}}
+
+updateField(Card, CreateTransition, AffectedCard, Field, NewValue) :-
+    createdCard(Card),
+    onTransitionSetField(Card, CreateTransition, AffectedCard, Field, NewValue),
+    field(Card, "cardType", CardType),
+    field(CardType, "workflow", Workflow),
+    workflowTransition(Workflow, CreateTransition, "", _),
+    not editingFieldDenied(AffectedCard, Field, _).
+
+executeTransition(Card, CreateTransition, AffectedCard, TransitionToExecute) :-
+    createdCard(Card),
+    onTransitionExecuteTransition(Card, CreateTransition, AffectedCard, TransitionToExecute),
+    field(Card, "cardType", CardType),
+    field(CardType, "workflow", Workflow),
+    workflowTransition(Workflow, CreateTransition, "", _),
+    not transitionDenied(AffectedCard, TransitionToExecute, _).
+
+selectAll.
+
+result(transitionSideEffects).
+
+childResult(transitionSideEffects, @concatenate("updateFields", Card, CreateTransition, AffectedCard, Field, NewValue), "updateFields") :-
+    updateField(Card, CreateTransition, AffectedCard, Field, NewValue).
+
+field(@concatenate("updateFields", Card, CreateTransition, AffectedCard, Field, NewValue), "card", AffectedCard) :-
+    updateField(Card, CreateTransition, AffectedCard, Field, NewValue).
+
+field(@concatenate("updateFields", Card, CreateTransition, AffectedCard, Field, NewValue), "field", Field) :-
+    updateField(Card, CreateTransition, AffectedCard, Field, NewValue).
+
+field(@concatenate("updateFields", Card, CreateTransition, AffectedCard, Field, NewValue), "newValue", NewValue) :-
+    updateField(Card, CreateTransition, AffectedCard, Field, NewValue).
+
+childResult(transitionSideEffects, @concatenate("executeTransition", Card, CreateTransition, AffectedCard, TransitionToExecute), "executeTransition") :-
+    executeTransition(Card, CreateTransition, AffectedCard, TransitionToExecute).
+
+field(@concatenate("executeTransition", Card, CreateTransition, AffectedCard, TransitionToExecute), "card", AffectedCard) :-
+    executeTransition(Card, CreateTransition, AffectedCard, TransitionToExecute).
+
+field(@concatenate("executeTransition", Card, CreateTransition, AffectedCard, TransitionToExecute), "transitionToExecute", TransitionToExecute) :-
+    executeTransition(Card, CreateTransition, AffectedCard, TransitionToExecute).

package/src/calculations/queries/onTransition.lp

@@ -0,0 +1,26 @@
+selectAll.
+
+result(transitionSideEffects).
+
+childResult(transitionSideEffects, @concatenate("updateFields", {{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue), "updateFields") :-
+    onTransitionSetField({{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue),
+    not editingFieldDenied(AffectedCard, Field, _).
+
+field(@concatenate("updateFields", {{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue), "card", AffectedCard) :-
+    onTransitionSetField({{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue).
+
+field(@concatenate("updateFields", {{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue), "field", Field) :-
+    onTransitionSetField({{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue).
+
+field(@concatenate("updateFields", {{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue), "newValue", NewValue) :-
+    onTransitionSetField({{cardKey}}, "{{transition}}", AffectedCard, Field, NewValue).
+
+childResult(transitionSideEffects, @concatenate("executeTransition", {{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute), "executeTransition") :-
+    onTransitionExecuteTransition({{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute),
+    not transitionDenied(AffectedCard, TransitionToExecute, _).
+
+field(@concatenate("executeTransition", {{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute), "card", AffectedCard) :-
+    onTransitionExecuteTransition({{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute).
+
+field(@concatenate("executeTransition", {{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute), "transitionToExecute", TransitionToExecute) :-
+    onTransitionExecuteTransition({{cardKey}}, "{{transition}}", AffectedCard, TransitionToExecute).

package/src/calculations/queries/tree.lp

@@ -0,0 +1,6 @@
+select("title";"statusIndicator";"progress";"rank";"cardType").
+result(Card) :- card(Card), not parent(Card, _), not hiddenInTreeView(Card).
+childResult(Parent, Card, "children") :- card(Card), parent(Card, Parent), not hiddenInTreeView(Card).
+order(Level, "children", 1, "rank", "ASC") :-
+    level(Level).
+

package/src/calculations/test/model.lp

@@ -0,0 +1,9 @@
+node(john).
+node(jane).
+edge((john,jane)).
+
+attr(graph, default, label, "Does' family").
+
+attr(graph_nodes, default, style, filled).
+attr(node, john, label, "John Doe").
+attr(node, jane, label, "Jane Doe").

package/src/declarations.d.ts

@@ -0,0 +1,9 @@
+declare module '*.lp' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.hbs' {
+  const content: string;
+  export default content;
+}

package/src/graphvizReport/index.adoc.hbs

@@ -0,0 +1,34 @@
+{{#*inline "subgraph"}}
+subgraph cluster_{{this.key}} {
+  graph [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+  {{#each edges}}
+    "{{this.[source]}}" -> "{{this.destination}}" [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+  {{/each}}
+  {{#each children}}
+    {{#if this.isNode}}
+      "{{this.cardKey}}" [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+    {{/if}}
+    {{#if this.isGraph}}
+      {{> subgraph}}
+    {{/if}}
+  {{/each}}
+}
+{{/inline}}
+{{#each results}}
+  {{#each digraphs}}
+    digraph {{this.key}} {
+      graph [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+      {{#each edges}}
+        "{{this.[source]}}" -> "{{this.destination}}" [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+      {{/each}}
+      {{#each children}}
+        {{#if this.isNode}}
+          "{{this.cardKey}}" [{{#each attrs}}{{this.attr}}={{{formatAttributeValue this.value}}} {{/each}}]
+        {{/if}}
+        {{#if this.isGraph}}
+          {{> subgraph}}
+        {{/if}}
+      {{/each}}
+    }
+  {{/each}}
+{{/each}}

package/src/graphvizReport/query.lp.hbs

@@ -0,0 +1,141 @@
+% model
+% note: not escaped
+{{{model}}}
+
+% include the view:
+{{{view}}}
+
+selectAll.
+
+result(result).
+
+% We need to format the label attributes without double quotes,
+% because labels already use HTML < and >, but we'll enclose other
+% attributes in double quotes, so here is a helper term to identify label attributes:
+labelAttribute("label").
+labelAttribute(label).
+
+% top-level graph
+childResult(result, Graph, "digraphs") :-
+    graph(Graph).
+
+childResult(Graph, ((graph, Graph), Field), "attrs") :-
+    graph(Graph),
+    attr(graph, Graph, Field, _).
+
+field(((graph, Graph), Field), "attr", Field) :-
+    graph(Graph),
+    attr(graph, Graph, Field, _).
+
+field(((graph, Graph), Field), "value", Value) :-
+    graph(Graph),
+    attr(graph, Graph, Field, Value),
+    labelAttribute(Field).
+
+field(((graph, Graph), Field), "value", Value) :-
+    graph(Graph),
+    attr(graph, Graph, Field, Value),
+    not labelAttribute(Field).
+
+% subgraphs
+childResult(Parent, Graph, "children") :-
+    graph(Graph, Parent).
+
+field(Graph, "isGraph", "void") :-
+    childResult(_, Graph, "children"),
+    graph(Graph, _).
+
+childResult(Graph, ((graph, Graph), Field), "attrs") :-
+    graph(Graph, _),
+    attr(graph, Graph, Field, _).
+
+field(((graph, Graph), Field), "attr", Field) :-
+    graph(Graph, _),
+    attr(graph, Graph, Field, _).
+
+field(((graph, Graph), Field), "value", Value) :-
+    graph(Graph, _),
+    attr(graph, Graph, Field, Value),
+    labelAttribute(Field).
+
+field(((graph, Graph), Field), "value", Value) :-
+    graph(Graph, _),
+    attr(graph, Graph, Field, Value),
+    not labelAttribute(Field).
+
+% nodes
+
+% TODO: For some reason, we need to use (node, Node) instead of Node, or
+% the solving will not succeed
+
+field((node, Node), "rank", Rank) :- field(Node, "rank", Rank), node(Node, _).
+
+field((node, Node), "isNode", "void") :-
+    childResult(_, (node, Node), "children"),
+    node(Node, _).
+
+childResult(Graph, (node, Node), "children") :-
+    childResult(_, Graph, _),
+    node(Node, Graph).
+
+field((node, Node), "cardKey", Node) :-
+    childResult(_, Graph, _),
+    node(Node, Graph).
+
+childResult((node, Node), ((node, Node), Field), "attrs") :-
+    node(Node, Graph),
+    attr(node, Node, Field, _).
+
+field(((node, Node), Field), "attr", Field) :-
+    node(Node, Graph),
+    attr(node, Node, Field, _).
+
+field(((node, Node), Field), "value", Value) :-
+    node(Node, Graph),
+    attr(node, Node, Field, Value),
+    labelAttribute(Field).
+
+field(((node, Node), Field), "value", Value) :-
+    node(Node, Graph),
+    attr(node, Node, Field, Value),
+    not labelAttribute(Field).
+
+graph(default) :-
+    node(_).
+
+graph(default) :-
+    edge(_).
+
+node(X, default) :-
+    node(X).
+
+edge((XR, YR), default) :-
+    edge((XR, YR)).
+
+edge((XR, YR, ""), Graph) :-
+    edge((XR, YR), Graph).
+
+% edges
+childResult(Graph, (edge, (XR, YR, Description)), "edges") :-
+    childResult(_, Graph, _),
+    edge((XR, YR, Description), Graph).
+
+childResult((edge, (XR, YR, Description)), ((edge, (XR, YR, Description)), Field), "attrs") :-
+    childResult(_, (edge, (XR, YR, Description)), _),
+    attr(edge, (XR, YR, Description), Field, _).
+
+field(((edge, (XR, YR, Description)), Field), "attr", Field) :-
+    childResult(_, (edge, (XR, YR, Description)), _),
+    attr(edge, (XR, YR, Description), Field, Value).
+
+field(((edge, (XR, YR, Description)), Field), "value", Value) :-
+    childResult(_, (edge, (XR, YR, Description)), _),
+    attr(edge, (XR, YR, Description), Field, Value).
+
+field((edge, (XR, YR, Description)), "source", XR) :-
+    edge((XR, YR, Description), _).
+
+field((edge, (XR, YR, Description)), "destination", YR) :-
+    edge((XR, YR, Description), _).
+
+order(N, Collection, 1, "rank", "ASC") :- resultLevel(_, N, Collection).

package/src/index.ts

@@ -0,0 +1,52 @@
+export * from './schemas.js';
+
+// Manually import each resource
+// 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 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 graphvizReportIndex from './graphvizReport/index.adoc.hbs';
+
+export const graphvizReport = {
+  query: graphvizReportQuery,
+  content: graphvizReportIndex,
+};
+
+export const lpFiles = {
+  common: {
+    base: commonBase,
+    queryLanguage: commonQueryLanguage,
+  },
+  queries: {
+    card: queriesCard,
+    onCreation: queriesOnCreation,
+    onTransition: queriesOnTransition,
+    tree: queriesTree,
+  },
+  test: {
+    model: testModel,
+  },
+};
+
+// Helper function to get the absolute path to the static directory
+export async function getStaticDirectoryPath(): Promise<string> {
+  // Return early if not running in Node.js
+  if (typeof process === 'undefined' || !process.versions?.node) {
+    throw new Error(
+      '@cyberismo/assets: getStaticDirectoryPath can only be called in Node.js',
+    );
+  }
+  const { join } = await import('node:path');
+
+  // Get the directory of the current module
+  const currentModuleDir = import.meta.dirname;
+
+  // Look for static directory in the package
+  return join(currentModuleDir, 'static');
+}

package/src/schema/cardBaseSchema.json

@@ -0,0 +1,76 @@
+{
+  "title": "Card",
+  "$id": "cardBaseSchema",
+  "description": "Cards represent different types of tickets, issues and documents. All cards must be valid against this parent schema.",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "cardType": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The name of the card type",
+      "pattern": "^[A-Za-z]*/?[A-Za-z]*/?[A-Za-z-_]+$"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "description": "A short title of the card"
+    },
+    "workflowState": {
+      "type": "string",
+      "description": "the name of the card's current state in the workflow"
+    },
+    "rank": {
+      "type": "string",
+      "description": "The rank of the card in relative to its siblings"
+    },
+    "lastTransitioned": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time of the last transition of the card"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time of the last update of the card"
+    },
+    "labels": {
+      "type": "array",
+      "description": "Labels or tags that can be used for organising cards",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "links": {
+      "type": "array",
+      "description": "links to or from this card to other cards",
+      "items": {
+        "type": "object",
+        "properties": {
+          "cardKey": {
+            "type": "string",
+            "minLength": 3,
+            "maxLength": 20,
+            "pattern": "^[a-z]+_[0-9a-z]+$"
+          },
+          "linkType": {
+            "description": "The name of the link type. For example, 'base/linkTypes/causes'",
+            "type": "string"
+          },
+          "linkDescription": {
+            "type": "string",
+            "description": "A description of the link"
+          }
+        },
+        "required": ["cardKey", "linkType"],
+        "additionalProperties": false
+      }
+    },
+    "templateCardKey": {
+      "type": "string",
+      "description": "Card key from which this card has been instantiated"
+    }
+  },
+  "required": ["title", "cardType", "workflowState", "rank"]
+}