@hestia-earth/api 0.10.1 → 0.11.2

package/dist/files/model/model.d.ts

@@ -66,6 +66,12 @@ export declare enum FilePipelineError {
     calculationEngineError = "calculationEngineError"
 }
 export declare type pipelineStatus = FilePipelineStatus | FilePipelineProgress | FilePipelineError;
+export interface IFileComment {
+    content: string;
+    date: Date;
+    user: User;
+    readonly isOwner?: boolean;
+}
 export declare class File extends BaseModel {
     filename: string;
     filepath: string;
@@ -81,7 +87,7 @@ export declare class File extends BaseModel {
     schemaVersion?: string;
     schemaOutdated?: boolean;
     glossaryOutdated?: boolean;
-    feedback?: string;
+    comments?: IFileComment[];
     metadata?: {
         slackThreadTs?: string;
     };
@@ -125,7 +131,9 @@ export declare const isAggregation: (path: string) => boolean;
 export declare const isFolderUpload: (path: string) => boolean;
 export declare const isOwner: (file: Partial<File>, user: User) => boolean;
 export declare const isAuthorized: ({ authorizedUsers }: Partial<File>, user: User) => boolean;
+export declare const canRemove: (file: Partial<File>, user: User) => boolean;
 export declare const canValidate: ({ status, isPrivate }: Partial<File>, { admin }: Partial<User>) => boolean;
 export declare const isValidated: ({ validatedAt, status }: Partial<File>) => boolean;
 export declare const canSubmit: (file: Partial<File>, user: User) => boolean;
+export declare const canFeedback: ({ status }: File) => boolean;
 export declare const isDraft: ({ filepath, filename }: Partial<File>) => boolean;

package/dist/files/model/model.js

@@ -20,7 +20,7 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
     return r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDraft = exports.canSubmit = exports.isValidated = exports.canValidate = exports.isAuthorized = exports.isOwner = exports.isFolderUpload = exports.isAggregation = exports.aggregationFolder = exports.isGlossary = exports.glossaryFolder = exports.filenameFromPath = exports.rootFolderFromPath = exports.folderFromPath = exports.replaceInvalidChars = exports.validPathChars = exports.fileToExt = exports.filepathSearch = exports.filenameSearch = exports.File = exports.FilePipelineError = exports.FilePipelineProgress = exports.FilePipelineStatus = exports.FileError = exports.FileStatus = exports.FileProgress = exports.HestiaExtensions = exports.SupportedExtensions = exports.sizeInMb = exports.MAX_SIZE_MB = exports.MAX_SIZE = exports.mb = void 0;
+exports.isDraft = exports.canFeedback = exports.canSubmit = exports.isValidated = exports.canValidate = exports.canRemove = exports.isAuthorized = exports.isOwner = exports.isFolderUpload = exports.isAggregation = exports.aggregationFolder = exports.isGlossary = exports.glossaryFolder = exports.filenameFromPath = exports.rootFolderFromPath = exports.folderFromPath = exports.replaceInvalidChars = exports.validPathChars = exports.fileToExt = exports.filepathSearch = exports.filenameSearch = exports.File = exports.FilePipelineError = exports.FilePipelineProgress = exports.FilePipelineStatus = exports.FileError = exports.FileStatus = exports.FileProgress = exports.HestiaExtensions = exports.SupportedExtensions = exports.sizeInMb = exports.MAX_SIZE_MB = exports.MAX_SIZE = exports.mb = void 0;
 var model_base_1 = require("../../db/model.base");
 exports.mb = 1048576;
 exports.MAX_SIZE = 2;
@@ -165,6 +165,11 @@ exports.isAuthorized = function (_a, user) {
     var authorizedUsers = _a.authorizedUsers;
     return (authorizedUsers || []).map(asString).includes(asString(user));
 };
+exports.canRemove = function (file, user) {
+    return user.admin ||
+        !exports.isValidated(file) ||
+        file.isPrivate;
+};
 var validateStatuses = [
     FileStatus.validateDataDone,
     FileStatus.indexJsonDone,
@@ -190,6 +195,14 @@ exports.canSubmit = function (file, user) {
     return submitStatuses.includes(file.status) &&
         !file.userValidatedAt && (exports.isOwner(file, user) || exports.isAuthorized(file, user));
 };
+var feedbackStatuses = [
+    FileStatus.validateDataDone,
+    FileError.validateDataError
+];
+exports.canFeedback = function (_a) {
+    var status = _a.status;
+    return feedbackStatuses.includes(status);
+};
 exports.isDraft = function (_a) {
     var filepath = _a.filepath, filename = _a.filename;
     return (filepath || filename || '').endsWith(SupportedExtensions.draft);

package/dist/nodes/model/model.js

@@ -117,7 +117,7 @@ var includeBlankNodes = function (logs, log) {
     }, logs);
 };
 var groupLog = function (group, _a) {
-    var logger = _a.logger, term = _a.term, model = _a.model, key = _a.key, should_run = _a.should_run, log = __rest(_a, ["logger", "term", "model", "key", "should_run"]);
+    var logger = _a.logger, term = _a.term, model = _a.model, key = _a.key, should_run = _a.should_run, run_required = _a.run_required, log = __rest(_a, ["logger", "term", "model", "key", "should_run", "run_required"]);
     var isOrchestrator = logger.includes('orchestrator');
     var modelKey = isOrchestrator ? model : key || model;
     var isKey = !isOrchestrator && !!key;
@@ -128,6 +128,10 @@ var groupLog = function (group, _a) {
         var shouldRun = should_run === 'True';
         group[term][modelKey] = isOrchestrator ? __assign(__assign({}, group[term][modelKey]), { shouldRunOrchestrator: shouldRun }) : __assign(__assign(__assign({}, group[term][modelKey]), omitLogKeys(log)), { shouldRun: shouldRun });
     }
+    else if (typeof run_required !== 'undefined') {
+        var runRequired = run_required === 'True';
+        group[term][modelKey] = __assign(__assign(__assign({}, group[term][modelKey]), (runRequired ? {} : omitLogKeys(log))), { runRequired: runRequired });
+    }
     else if ('requirements' in log) {
         var requirements = log.requirements, logData = __rest(log, ["requirements"]);
         group[term][modelKey].requirements = __assign(__assign({}, (group[term][modelKey].requirements || {})), logData);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/api",
-  "version": "0.10.1",
+  "version": "0.11.2",
   "description": "Hestia API definitions",
   "main": "dist/models.js",
   "typings": "dist/models.d.ts",