@cyberismo/data-handler 0.0.2

package/dist/utils/clingo-facts.js

@@ -0,0 +1,352 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import { sep } from 'node:path';
+import { ClingoFactBuilder, } from './clingo-fact-builder.js';
+import { ClingoProgramBuilder } from './clingo-program-builder.js';
+import { isPredefinedField } from './constants.js';
+import { isTemplateCard } from '../utils/card-utils.js';
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export var Facts;
+(function (Facts) {
+    let Card;
+    (function (Card) {
+        Card["LABEL"] = "label";
+        Card["LINK"] = "userLink";
+        Card["PARENT"] = "parent";
+    })(Card = Facts.Card || (Facts.Card = {}));
+    let Common;
+    (function (Common) {
+        Common["FIELD"] = "field";
+        Common["MODULE"] = "module";
+        Common["PROJECT"] = "project";
+    })(Common = Facts.Common || (Facts.Common = {}));
+    let CardType;
+    (function (CardType) {
+        CardType["ALWAYS_VISIBLE_FIELD"] = "alwaysVisibleField";
+        CardType["CALCULATED_FIELD"] = "calculatedField";
+        CardType["CARD_TYPE"] = "cardType";
+        CardType["CUSTOM_FIELD"] = "customField";
+        CardType["OPTIONALLY_VISIBLE_FIELD"] = "optionallyVisibleField";
+    })(CardType = Facts.CardType || (Facts.CardType = {}));
+    let FieldType;
+    (function (FieldType) {
+        FieldType["ENUM_VALUE"] = "enumValue";
+        FieldType["FIELD_TYPE"] = "fieldType";
+    })(FieldType = Facts.FieldType || (Facts.FieldType = {}));
+    let LinkType;
+    (function (LinkType) {
+        LinkType["LINK_DESTINATION_CARD_TYPE"] = "linkDestinationCardType";
+        LinkType["LINK_SOURCE_CARD_TYPE"] = "linkSourceCardType";
+        LinkType["LINK_TYPE"] = "linkType";
+    })(LinkType = Facts.LinkType || (Facts.LinkType = {}));
+    let Report;
+    (function (Report) {
+        Report["REPORT"] = "report";
+    })(Report = Facts.Report || (Facts.Report = {}));
+    let Template;
+    (function (Template) {
+        Template["TEMPLATE"] = "template";
+    })(Template = Facts.Template || (Facts.Template = {}));
+    let Workflow;
+    (function (Workflow) {
+        Workflow["WORKFLOW"] = "workflow";
+        Workflow["WORKFLOW_STATE"] = "workflowState";
+        Workflow["WORKFLOW_TRANSITION"] = "workflowTransition";
+    })(Workflow = Facts.Workflow || (Facts.Workflow = {}));
+})(Facts || (Facts = {}));
+// Compares two index values.
+function compareIndex(a, b) {
+    if (a === -1 && b === -1) {
+        return 0;
+    }
+    else if (a === -1) {
+        return 1;
+    }
+    else if (b === -1) {
+        return -1;
+    }
+    return a - b;
+}
+/**
+ * Creates Clingo facts for a workflow.
+ * @param workflow Workflow metadata
+ * @returns clingo facts as a string
+ */
+export const createWorkflowFacts = (workflow) => {
+    const builder = new ClingoProgramBuilder().addFact(Facts.Workflow.WORKFLOW, workflow.name);
+    // add states
+    for (const state of workflow.states) {
+        if (state.category) {
+            builder.addFact(Facts.Workflow.WORKFLOW_STATE, workflow.name, state.name, state.category);
+        }
+        else {
+            builder.addFact(Facts.Workflow.WORKFLOW_STATE, workflow.name, state.name);
+        }
+    }
+    // add transitions
+    for (const transition of workflow.transitions) {
+        for (const from of transition.fromState) {
+            builder.addFact(Facts.Workflow.WORKFLOW_TRANSITION, workflow.name, transition.name, from, transition.toState);
+        }
+        if (transition.fromState.length === 0) {
+            builder.addFact(Facts.Workflow.WORKFLOW_TRANSITION, workflow.name, transition.name, '', transition.toState);
+        }
+    }
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a card.
+ * @param card Card information
+ * @param project Project information
+ * @returns clingo facts as a string
+ */
+export const createCardFacts = async (card, project) => {
+    // Small helper to deduce parent path
+    function parentPath(cardPath) {
+        const pathParts = cardPath.split(sep);
+        if (pathParts.at(pathParts.length - 2) === 'cardRoot') {
+            return '';
+        }
+        else {
+            return pathParts.at(pathParts.length - 3);
+        }
+    }
+    // Helper to deduce template parent path.
+    function parentPathFromTemplate(card) {
+        const cardPath = card.path;
+        const pathParts = cardPath.split(sep);
+        if (pathParts.length <= 6) {
+            // template or module template paths should have a minimum of seven parts.
+            return '';
+        }
+        if (isTemplateCard(card)) {
+            // Parent is a card
+            if (pathParts.at(pathParts.length - 4) === 'c') {
+                return pathParts.at(pathParts.length - 3);
+            }
+            // Parent is a template
+            const prefix = pathParts.at(pathParts.length - 5) === 'local'
+                ? project.projectPrefix
+                : pathParts.at(pathParts.length - 5);
+            const resourceType = pathParts.at(pathParts.length - 4);
+            const templateName = pathParts.at(pathParts.length - 3);
+            return `"${prefix}/${resourceType}/${templateName}"`;
+        }
+    }
+    const parentsPath = isTemplateCard(card)
+        ? parentPathFromTemplate(card)
+        : parentPath(card.path);
+    const builder = new ClingoProgramBuilder().addComment(card.key);
+    if (card.metadata) {
+        for (const [field, value] of Object.entries(card.metadata)) {
+            if (field === 'labels') {
+                for (const label of value) {
+                    builder.addCustomFact(Facts.Card.LABEL, (b) => b.addLiteralArgument(card.key).addArgument(label));
+                }
+            }
+            else if (field === 'links') {
+                for (const link of value) {
+                    builder.addCustomFact(Facts.Card.LINK, (b) => b
+                        .addLiteralArguments(card.key, link.cardKey)
+                        .addArguments(link.linkType, link.linkDescription ?? null));
+                }
+            }
+            else {
+                // Do not write null values
+                if (value == null) {
+                    continue;
+                }
+                // field might be a non-custom field, which cannot use the fieldType method
+                let clingoValue = value.toString();
+                if (!isPredefinedField(field)) {
+                    // field is a custom field, find it
+                    const fieldType = await project.resource(field);
+                    if (!fieldType) {
+                        continue;
+                    }
+                    // if it's a list, let's generate multiple values
+                    if (fieldType.dataType === 'list') {
+                        if (!Array.isArray(value)) {
+                            continue;
+                        }
+                        for (const listValue of value) {
+                            builder.addCustomFact(Facts.Common.FIELD, (b) => b
+                                .addLiteralArgument(card.key)
+                                .addArguments(field, listValue.toString()));
+                        }
+                        continue;
+                    }
+                    clingoValue =
+                        fieldType.dataType === 'integer'
+                            ? value
+                            : value.toString();
+                }
+                builder.addCustomFact(Facts.Common.FIELD, (b) => b.addLiteralArgument(card.key).addArguments(field, clingoValue));
+            }
+        }
+    }
+    if (parentsPath !== undefined && parentsPath !== '') {
+        builder.addCustomFact(Facts.Card.PARENT, (b) => b.addLiteralArguments(card.key, parentsPath));
+    }
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a field type.
+ * @param fieldType Field type metadata
+ * @returns clingo facts as a string
+ */
+export const createFieldTypeFacts = (fieldType) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.FieldType.FIELD_TYPE, fieldType.name);
+    if (fieldType.displayName)
+        builder.addFact(Facts.Common.FIELD, fieldType.name, 'displayName', fieldType.displayName);
+    if (fieldType.fieldDescription)
+        builder.addFact(Facts.Common.FIELD, fieldType.name, 'fieldDescription', fieldType.fieldDescription);
+    builder.addFact(Facts.Common.FIELD, fieldType.name, 'dataType', fieldType.dataType);
+    if (fieldType.enumValues) {
+        let index = 1;
+        for (const enumValue of fieldType.enumValues) {
+            builder.addFact(Facts.FieldType.ENUM_VALUE, fieldType.name, enumValue.enumValue);
+            builder.addCustomFact(Facts.Common.FIELD, (b) => b
+                .addArgument((key) => key.addArguments(fieldType.name, enumValue.enumValue))
+                .addArguments('index', index++));
+            const keyTuple = new ClingoFactBuilder('', '').addArguments(fieldType.name, enumValue.enumValue);
+            if (enumValue.enumDisplayValue)
+                builder.addCustomFact(Facts.Common.FIELD, (b) => b
+                    .addArgument(keyTuple)
+                    .addArguments('enumDisplayValue', enumValue.enumDisplayValue));
+            if (enumValue.enumDescription)
+                builder.addCustomFact(Facts.Common.FIELD, (b) => b
+                    .addArgument(keyTuple)
+                    .addArguments('enumDescription', enumValue.enumDescription));
+        }
+    }
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a card type.
+ * @param cardType Card type metadata
+ * @returns clingo facts as a string
+ */
+export const createCardTypeFacts = (cardType) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.CardType.CARD_TYPE, cardType.name);
+    builder.addFact(Facts.Common.FIELD, cardType.name, 'workflow', cardType.workflow);
+    const customFields = cardType.customFields.toSorted((a, b) => {
+        const aFirstIndex = cardType.alwaysVisibleFields.indexOf(a.name);
+        const bFirstIndex = cardType.alwaysVisibleFields.indexOf(b.name);
+        const aSecondIndex = cardType.optionallyVisibleFields.indexOf(a.name);
+        const bSecondIndex = cardType.optionallyVisibleFields.indexOf(b.name);
+        return compareIndex(aFirstIndex, bFirstIndex) === 0
+            ? compareIndex(aSecondIndex, bSecondIndex)
+            : compareIndex(aFirstIndex, bFirstIndex);
+    });
+    let index = 1;
+    for (const customField of customFields) {
+        builder.addFact(Facts.CardType.CUSTOM_FIELD, cardType.name, customField.name);
+        const keyTuple = new ClingoFactBuilder('', '').addArguments(cardType.name, customField.name);
+        if (customField.displayName) {
+            builder.addCustomFact(Facts.Common.FIELD, (b) => b.addArgument(keyTuple).addArguments('displayName', customField.displayName));
+        }
+        if (customField.isCalculated) {
+            builder.addFact(Facts.CardType.CALCULATED_FIELD, cardType.name, customField.name);
+        }
+        let visible = false;
+        if (cardType.alwaysVisibleFields.includes(customField.name)) {
+            builder.addFact(Facts.CardType.ALWAYS_VISIBLE_FIELD, cardType.name, customField.name);
+            visible = true;
+        }
+        if (cardType.optionallyVisibleFields.includes(customField.name)) {
+            builder.addFact(Facts.CardType.OPTIONALLY_VISIBLE_FIELD, cardType.name, customField.name);
+            visible = true;
+        }
+        if (visible) {
+            builder.addCustomFact(Facts.Common.FIELD, (b) => b
+                .addArgument((key) => key.addArguments(cardType.name, customField.name))
+                .addArguments('index', index++));
+        }
+    }
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a link type.
+ * @param linkType Link type metadata
+ * @returns clingo facts as a string
+ */
+export const createLinkTypeFacts = (linkType) => {
+    const builder = new ClingoProgramBuilder()
+        .addFact(Facts.LinkType.LINK_TYPE, linkType.name)
+        .addFact(Facts.Common.FIELD, linkType.name, 'outboundDisplayName', linkType.outboundDisplayName)
+        .addFact(Facts.Common.FIELD, linkType.name, 'inboundDisplayName', linkType.inboundDisplayName)
+        .addFact(Facts.Common.FIELD, linkType.name, 'enableLinkDescription', linkType.enableLinkDescription);
+    for (const sourceCardType of linkType.sourceCardTypes) {
+        builder.addFact(Facts.LinkType.LINK_SOURCE_CARD_TYPE, linkType.name, sourceCardType);
+    }
+    for (const destinationCardType of linkType.destinationCardTypes) {
+        builder.addFact(Facts.LinkType.LINK_DESTINATION_CARD_TYPE, linkType.name, destinationCardType);
+    }
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a module.
+ * @param module Module metadata
+ * @returns clingo facts as a string
+ */
+export const createModuleFacts = (module) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.Common.MODULE, module.cardKeyPrefix);
+    builder.addFact(Facts.Common.FIELD, module.cardKeyPrefix, 'name', module.name);
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a project.
+ * @param projectPrefix Card prefix of the project
+ * @returns clingo facts as a string
+ */
+export const createProjectFacts = (projectPrefix) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.Common.PROJECT, projectPrefix);
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts for a report.
+ * @param report Report metadata
+ * @returns clingo facts as a string
+ */
+export const createReportFacts = (report) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.Report.REPORT, report.name);
+    if (report.displayName)
+        builder.addFact(Facts.Common.FIELD, report.name, 'displayName', report.displayName);
+    if (report.description)
+        builder.addFact(Facts.Common.FIELD, report.name, 'description', report.description);
+    if (report.category)
+        builder.addFact(Facts.Common.FIELD, report.name, 'category', report.category);
+    return builder.buildAll();
+};
+/**
+ * Creates Clingo facts about template.
+ * @param template Template metadata
+ * @returns clingo facts as a string
+ */
+export const createTemplateFacts = (template) => {
+    const builder = new ClingoProgramBuilder();
+    builder.addFact(Facts.Template.TEMPLATE, template.name);
+    if (template.displayName)
+        builder.addFact(Facts.Common.FIELD, template.name, 'displayName', template.displayName);
+    if (template.description)
+        builder.addFact(Facts.Common.FIELD, template.name, 'description', template.description);
+    if (template.category)
+        builder.addFact(Facts.Common.FIELD, template.name, 'category', template.category);
+    return builder.buildAll();
+};
+//# sourceMappingURL=clingo-facts.js.map

package/dist/utils/clingo-facts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clingo-facts.js","sourceRoot":"","sources":["../../src/utils/clingo-facts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,OAAO,EAEL,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAWlC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAGxD,2DAA2D;AAC3D,MAAM,KAAW,KAAK,CA6CrB;AA7CD,WAAiB,KAAK;IACpB,IAAY,IAIX;IAJD,WAAY,IAAI;QACd,uBAAe,CAAA;QACf,yBAAiB,CAAA;QACjB,yBAAiB,CAAA;IACnB,CAAC,EAJW,IAAI,GAAJ,UAAI,KAAJ,UAAI,QAIf;IAED,IAAY,MAIX;IAJD,WAAY,MAAM;QAChB,yBAAe,CAAA;QACf,2BAAiB,CAAA;QACjB,6BAAmB,CAAA;IACrB,CAAC,EAJW,MAAM,GAAN,YAAM,KAAN,YAAM,QAIjB;IAED,IAAY,QAMX;IAND,WAAY,QAAQ;QAClB,uDAA2C,CAAA;QAC3C,gDAAoC,CAAA;QACpC,kCAAsB,CAAA;QACtB,wCAA4B,CAAA;QAC5B,+DAAmD,CAAA;IACrD,CAAC,EANW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAMnB;IAED,IAAY,SAGX;IAHD,WAAY,SAAS;QACnB,qCAAwB,CAAA;QACxB,qCAAwB,CAAA;IAC1B,CAAC,EAHW,SAAS,GAAT,eAAS,KAAT,eAAS,QAGpB;IAED,IAAY,QAIX;IAJD,WAAY,QAAQ;QAClB,kEAAsD,CAAA;QACtD,wDAA4C,CAAA;QAC5C,kCAAsB,CAAA;IACxB,CAAC,EAJW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAInB;IAED,IAAY,MAEX;IAFD,WAAY,MAAM;QAChB,2BAAiB,CAAA;IACnB,CAAC,EAFW,MAAM,GAAN,YAAM,KAAN,YAAM,QAEjB;IAED,IAAY,QAEX;IAFD,WAAY,QAAQ;QAClB,iCAAqB,CAAA;IACvB,CAAC,EAFW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAEnB;IAED,IAAY,QAIX;IAJD,WAAY,QAAQ;QAClB,iCAAqB,CAAA;QACrB,4CAAgC,CAAA;QAChC,sDAA0C,CAAA;IAC5C,CAAC,EAJW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAInB;AACH,CAAC,EA7CgB,KAAK,KAAL,KAAK,QA6CrB;AAED,6BAA6B;AAC7B,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS;IACxC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAkB,EAAE,EAAE;IACxD,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC,OAAO,CAChD,KAAK,CAAC,QAAQ,CAAC,QAAQ,EACvB,QAAQ,CAAC,IAAI,CACd,CAAC;IACF,aAAa;IACb,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,cAAc,EAC7B,QAAQ,CAAC,IAAI,EACb,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,CACf,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,kBAAkB;IAClB,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC9C,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;YACxC,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,mBAAmB,EAClC,QAAQ,CAAC,IAAI,EACb,UAAU,CAAC,IAAI,EACf,IAAI,EACJ,UAAU,CAAC,OAAO,CACnB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,mBAAmB,EAClC,QAAQ,CAAC,IAAI,EACb,UAAU,CAAC,IAAI,EACf,EAAE,EACF,UAAU,CAAC,OAAO,CACnB,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,IAAU,EAAE,OAAgB,EAAE,EAAE;IACpE,qCAAqC;IACrC,SAAS,UAAU,CAAC,QAAgB;QAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,SAAS,sBAAsB,CAAC,IAAU;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;QAC3B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC1B,0EAA0E;YAC1E,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,mBAAmB;YACnB,IAAI,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBAC/C,OAAO,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,uBAAuB;YACvB,MAAM,MAAM,GACV,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,OAAO;gBAC5C,CAAC,CAAC,OAAO,CAAC,aAAa;gBACvB,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACxD,MAAM,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACxD,OAAO,IAAI,MAAM,IAAI,YAAY,IAAI,YAAY,GAAG,CAAC;QACvD,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC;QACtC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC;QAC9B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACvB,KAAK,MAAM,KAAK,IAAI,KAAsB,EAAE,CAAC;oBAC3C,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC5C,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAClD,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC7B,KAAK,MAAM,IAAI,IAAI,KAAe,EAAE,CAAC;oBACnC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAC3C,CAAC;yBACE,mBAAmB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC;yBAC3C,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,CAC7D,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,2BAA2B;gBAC3B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;oBAClB,SAAS;gBACX,CAAC;gBACD,2EAA2E;gBAE3E,IAAI,WAAW,GAAsB,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAEtD,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC9B,mCAAmC;oBACnC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAY,KAAK,CAAC,CAAC;oBAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;wBACf,SAAS;oBACX,CAAC;oBAED,iDAAiD;oBACjD,IAAI,SAAS,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;wBAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;4BAC1B,SAAS;wBACX,CAAC;wBACD,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;4BAC9B,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC;iCACE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;iCAC5B,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAC7C,CAAC;wBACJ,CAAC;wBACD,SAAS;oBACX,CAAC;oBAED,WAAW;wBACT,SAAS,CAAC,QAAQ,KAAK,SAAS;4BAC9B,CAAC,CAAE,KAAgB;4BACnB,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACzB,CAAC;gBAED,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAChE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;QACpD,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAC7C,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAC7C,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC3D,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAE5D,IAAI,SAAS,CAAC,WAAW;QACvB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,SAAS,CAAC,IAAI,EACd,aAAa,EACb,SAAS,CAAC,WAAW,CACtB,CAAC;IAEJ,IAAI,SAAS,CAAC,gBAAgB;QAC5B,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,SAAS,CAAC,IAAI,EACd,kBAAkB,EAClB,SAAS,CAAC,gBAAgB,CAC3B,CAAC;IAEJ,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,SAAS,CAAC,IAAI,EACd,UAAU,EACV,SAAS,CAAC,QAAQ,CACnB,CAAC;IAEF,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;QACzB,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YAC7C,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,SAAS,CAAC,UAAU,EAC1B,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,SAAS,CACpB,CAAC;YACF,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC;iBACE,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CACtD;iBACA,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAClC,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CACzD,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,SAAS,CACpB,CAAC;YAEF,IAAI,SAAS,CAAC,gBAAgB;gBAC5B,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC;qBACE,WAAW,CAAC,QAAQ,CAAC;qBACrB,YAAY,CAAC,kBAAkB,EAAE,SAAS,CAAC,gBAAiB,CAAC,CACjE,CAAC;YAEJ,IAAI,SAAS,CAAC,eAAe;gBAC3B,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC;qBACE,WAAW,CAAC,QAAQ,CAAC;qBACrB,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAAC,eAAgB,CAAC,CAC/D,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAkB,EAAE,EAAE;IACxD,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAE3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEzD,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,UAAU,EACV,QAAQ,CAAC,QAAQ,CAClB,CAAC;IAEF,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC3D,MAAM,WAAW,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,WAAW,GAAG,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEjE,MAAM,YAAY,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,YAAY,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEtE,OAAO,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,KAAK,CAAC;YACjD,CAAC,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC;YAC1C,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IACH,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,YAAY,EAC3B,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,IAAI,CACjB,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CACzD,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,IAAI,CACjB,CAAC;QACF,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;YAC5B,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,YAAY,CAClC,aAAa,EACb,WAAW,CAAC,WAAqB,CAClC,CACF,CAAC;QACJ,CAAC;QACD,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC;YAC7B,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,gBAAgB,EAC/B,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,IAAI,CACjB,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,oBAAoB,EACnC,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,IAAI,CACjB,CAAC;YACF,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QACD,IAAI,QAAQ,CAAC,uBAAuB,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAChE,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,wBAAwB,EACvC,QAAQ,CAAC,IAAI,EACb,WAAW,CAAC,IAAI,CACjB,CAAC;YACF,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAC9C,CAAC;iBACE,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CAClD;iBACA,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAClC,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAkB,EAAE,EAAE;IACxD,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE;SACvC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC;SAChD,OAAO,CACN,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,qBAAqB,EACrB,QAAQ,CAAC,mBAAmB,CAC7B;SACA,OAAO,CACN,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,oBAAoB,EACpB,QAAQ,CAAC,kBAAkB,CAC5B;SACA,OAAO,CACN,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,uBAAuB,EACvB,QAAQ,CAAC,qBAAqB,CAC/B,CAAC;IAEJ,KAAK,MAAM,cAAc,IAAI,QAAQ,CAAC,eAAe,EAAE,CAAC;QACtD,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,qBAAqB,EACpC,QAAQ,CAAC,IAAI,EACb,cAAc,CACf,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,mBAAmB,IAAI,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QAChE,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,QAAQ,CAAC,0BAA0B,EACzC,QAAQ,CAAC,IAAI,EACb,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAqB,EAAE,EAAE;IACzD,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;IAC3D,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,MAAM,CAAC,aAAa,EACpB,MAAM,EACN,MAAM,CAAC,IAAI,CACZ,CAAC;IACF,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,aAAqB,EAAE,EAAE;IAC1D,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IACrD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAsB,EAAE,EAAE;IAC1D,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAElD,IAAI,MAAM,CAAC,WAAW;QACpB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,MAAM,CAAC,IAAI,EACX,aAAa,EACb,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,IAAI,MAAM,CAAC,WAAW;QACpB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,MAAM,CAAC,IAAI,EACX,aAAa,EACb,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,IAAI,MAAM,CAAC,QAAQ;QACjB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,MAAM,CAAC,IAAI,EACX,UAAU,EACV,MAAM,CAAC,QAAQ,CAChB,CAAC;IACJ,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAA0B,EAAE,EAAE;IAChE,MAAM,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAExD,IAAI,QAAQ,CAAC,WAAW;QACtB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,aAAa,EACb,QAAQ,CAAC,WAAW,CACrB,CAAC;IACJ,IAAI,QAAQ,CAAC,WAAW;QACtB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,aAAa,EACb,QAAQ,CAAC,WAAW,CACrB,CAAC;IACJ,IAAI,QAAQ,CAAC,QAAQ;QACnB,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,MAAM,CAAC,KAAK,EAClB,QAAQ,CAAC,IAAI,EACb,UAAU,EACV,QAAQ,CAAC,QAAQ,CAClB,CAAC;IACJ,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC,CAAC"}

package/dist/utils/clingo-parser.d.ts

@@ -0,0 +1,59 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import type { BaseResult, ParseResult } from '../types/queries.js';
+/**
+ * This function reverses the encoding made by the "encodeClingoValue" function
+ */
+export declare function decodeClingoValue(value: string): string;
+declare class ClingoParser {
+    private keywords;
+    private result;
+    private resultQueue;
+    private childResultQueue;
+    private tempResults;
+    private orderQueue;
+    private collections;
+    private reset;
+    /**
+     * Command handlers for each possible keyword
+     * All of them will get parameters as strings
+     * You can trust that clingo will always provide the correct number of parameters / types
+     */
+    private commandHandlers;
+    private getOrInitResult;
+    private sortByLevel;
+    private getComparableValue;
+    private applyResultProcessing;
+    /**
+     * This methods is responsible for converting clingo output to a parsed object
+     * @param input clingo input to parse
+     * @returns
+     */
+    parseInput(input: string): Promise<ParseResult<BaseResult>>;
+    /**
+     * This method finds the next keyword in a string after a specified point
+     * @param input The string which it being searched
+     * @param start The position from which to start the search from
+     * @returns
+     */
+    private findKeyword;
+    /**
+     * This method is a custom parser, which takes in the whole clingo output and parses the arguments.
+     * Note: Do not decode in this function. It will be handled on a higher level.
+     * As long as this function returns valid clingo, it has done it's responsibility
+     * @param input Clingo output
+     * @param position Position of the command being parsed inside the string
+     * @returns
+     */
+    private parseArguments;
+}
+export default ClingoParser;