@cyberismo/data-handler 0.0.6 → 0.0.8

package/dist/macros/report/index.js

@@ -1,26 +1,28 @@
 /**
-    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/>.
+  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 { registerEmptyMacros, validateMacroContent } from '../index.js';
+import { validateMacroContent } from '../index.js';
 import macroMetadata from './metadata.js';
-import { Project } from '../../containers/project.js';
-import { Calculate } from '../../commands/index.js';
-import Handlebars from 'handlebars';
 import BaseMacro from '../base-macro.js';
 import { validateJson } from '../../utils/validate.js';
 import { ReportResource } from '../../resources/report-resource.js';
 import { resourceName } from '../../utils/resource-utils.js';
+import { generateReportContent } from '../../utils/report.js';
+import { ClingoError } from '@cyberismo/node-clingo';
 class ReportMacro extends BaseMacro {
-    constructor(tasksQueue) {
-        super(macroMetadata, tasksQueue);
+    calculate;
+    constructor(tasks, calculate) {
+        super(macroMetadata, tasks);
+        this.calculate = calculate;
     }
     handleValidate = (input) => {
         this.validate(input);
@@ -30,37 +32,32 @@ class ReportMacro extends BaseMacro {
     };
     handleInject = async (context, data) => {
         const options = this.validate(data);
-        const project = new Project(context.projectPath);
-        const resource = new ReportResource(project, resourceName(options.name));
+        const resource = new ReportResource(context.project, resourceName(options.name));
         const report = await resource.show();
         if (!report)
-            throw new Error(`Report ${options} does not exist`);
+            throw new Error(`Report ${options.name} does not exist`);
         if (report.schema) {
             validateJson(options, {
                 schema: report.schema,
             });
         }
-        const handlebarsContext = {
-            cardKey: context.cardKey,
-            ...options,
-        };
-        const handlebars = Handlebars.create();
-        const template = handlebars.compile(report.queryTemplate, {
-            strict: true,
-        });
-        const calculate = new Calculate(project);
-        const result = await calculate.runLogicProgram({
-            query: template(handlebarsContext),
-        });
-        if (result.error) {
-            throw new Error(result.error);
+        try {
+            return await generateReportContent({
+                calculate: this.calculate,
+                contentTemplate: report.contentTemplate,
+                queryTemplate: report.queryTemplate,
+                options: {
+                    cardKey: context.cardKey,
+                    ...options,
+                },
+            });
+        }
+        catch (error) {
+            if (error instanceof ClingoError) {
+                throw new Error(`Error running logic program in report '${options.name}':${error.details.errors.join('\n')}`);
+            }
+            throw error;
         }
-        // register empty macros so that other macros aren't touched yet
-        registerEmptyMacros(handlebars);
-        return handlebars.compile(report.contentTemplate)({
-            ...handlebarsContext,
-            ...result,
-        });
     };
     validate(data) {
         return validateMacroContent(this.metadata, data);

package/dist/macros/report/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/macros/report/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGxE,OAAO,aAAa,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,SAAS,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAM7D,MAAM,WAAY,SAAQ,SAAS;IACjC,YAAY,UAAqB;QAC/B,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACnC,CAAC;IACD,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,IAAa,EAAE,EAAE;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,IAAa,EAAE,EAAE;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,UAAU,OAAO,iBAAiB,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,YAAY,CAAC,OAAO,EAAE;gBACpB,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,iBAAiB,GAAG;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,OAAO;SACX,CAAC;QAEF,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEvC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACxD,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC;YAC7C,KAAK,EAAE,QAAQ,CAAC,iBAAiB,CAAC;SACnC,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,gEAAgE;QAChE,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEhC,OAAO,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAChD,GAAG,iBAAiB;YACpB,GAAG,MAAM;SACV,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,QAAQ,CAAC,IAAa;QAC5B,OAAO,oBAAoB,CAAgB,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/macros/report/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;EAWE;AAEF,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAInD,OAAO,aAAa,MAAM,eAAe,CAAC;AAE1C,OAAO,SAAS,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAMrD,MAAM,WAAY,SAAQ,SAAS;IAGd;IAFnB,YACE,KAAgB,EACC,SAAoB;QAErC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAFX,cAAS,GAAT,SAAS,CAAW;IAGvC,CAAC;IACD,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,IAAa,EAAE,EAAE;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,IAAa,EAAE,EAAE;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,cAAc,CACjC,OAAO,CAAC,OAAO,EACf,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAC3B,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,UAAU,OAAO,CAAC,IAAI,iBAAiB,CAAC,CAAC;QAEtE,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,YAAY,CAAC,OAAO,EAAE;gBACpB,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,qBAAqB,CAAC;gBACjC,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,GAAG,OAAO;iBACX;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,0CAA0C,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7F,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEM,QAAQ,CAAC,IAAa;QAC5B,OAAO,oBAAoB,CAAgB,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}

package/dist/module-manager.d.ts

@@ -10,37 +10,42 @@
   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 { Import } from './commands/index.js';
-import type { ModuleSettingOptions } from './interfaces/project-interfaces.js';
+import type { Credentials, ModuleSetting, ModuleSettingOptions } from './interfaces/project-interfaces.js';
 import { Project } from './containers/project.js';
 /**
  * Class that handles module updates and imports.
  */
 export declare class ModuleManager {
     private project;
-    private importCmd;
     private modules;
     private tempModulesDir;
-    constructor(project: Project, importCmd: Import);
+    private defaultBranchCache;
+    constructor(project: Project);
     private addFileContents;
-    private branch;
+    private buildDependencyGraph;
+    private canBeRemoved;
     private clone;
     private collectModulePrefixes;
     private configuration;
+    private defaultBranch;
+    private dependencies;
     private doCollectModulePrefix;
     private handleFileModule;
     private handleGitModule;
     private handleModule;
     private importFromFolder;
-    private importFromTemp;
     private isFileModule;
+    private isGitModule;
+    private orphanedModules;
     private prepare;
-    private protocol;
     private remove;
-    private removeModuleFiles;
-    private removeProtocolFromLocation;
     private removeDuplicates;
+    private removeModuleFiles;
     private repositoryName;
+    private setCloneOptions;
+    private stripProtocolFromLocation;
+    private transientDependencies;
+    private update;
     private validatePrefix;
     /**
      * Imports module from local file path.
@@ -52,11 +57,27 @@ export declare class ModuleManager {
      * Imports module from gitUrl.
      * @param source Git URL to import from.
      * @param options Modules setting options.
+     * @param credentials Credentials for private repositories.
      * @returns module prefix as defined in its CardsConfig.json
      */
-    importGitModule(source: string, options?: ModuleSettingOptions): Promise<string>;
+    importGitModule(source: string, options?: ModuleSettingOptions, credentials?: Credentials): Promise<string>;
+    /**
+     * Removed module from project.
+     * If module is not used by any other modules, then will remove the module from disk as well.
+     * Otherwise, only updates project configuration.
+     * @param moduleName Name of the module to remove
+     */
+    removeModule(moduleName: string): Promise<void>;
+    /**
+     * Imports module from a local file path or a git URL.
+     * @param module Module to update. If not provided, updates all modules.
+     * @param credentials Optional credentials for private repositories.
+     * @returns Module prefix as defined in its CardsConfig.json
+     */
+    updateModule(module: ModuleSetting, credentials?: Credentials): Promise<void>;
     /**
      * Updates all imported modules.
+     * @param credentials Optional credentials for private modules.
      */
-    update(): Promise<void>;
+    updateModules(credentials?: Credentials): Promise<void>;
 }