@hestia-earth/api 0.10.1 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -66,6 +66,12 @@ export declare enum FilePipelineError {
66
66
  calculationEngineError = "calculationEngineError"
67
67
  }
68
68
  export declare type pipelineStatus = FilePipelineStatus | FilePipelineProgress | FilePipelineError;
69
+ export interface IFileComment {
70
+ content: string;
71
+ date: Date;
72
+ user: User;
73
+ readonly isOwner?: boolean;
74
+ }
69
75
  export declare class File extends BaseModel {
70
76
  filename: string;
71
77
  filepath: string;
@@ -81,7 +87,7 @@ export declare class File extends BaseModel {
81
87
  schemaVersion?: string;
82
88
  schemaOutdated?: boolean;
83
89
  glossaryOutdated?: boolean;
84
- feedback?: string;
90
+ comments?: IFileComment[];
85
91
  metadata?: {
86
92
  slackThreadTs?: string;
87
93
  };
@@ -128,4 +134,5 @@ export declare const isAuthorized: ({ authorizedUsers }: Partial<File>, user: Us
128
134
  export declare const canValidate: ({ status, isPrivate }: Partial<File>, { admin }: Partial<User>) => boolean;
129
135
  export declare const isValidated: ({ validatedAt, status }: Partial<File>) => boolean;
130
136
  export declare const canSubmit: (file: Partial<File>, user: User) => boolean;
137
+ export declare const canFeedback: ({ status }: File) => boolean;
131
138
  export declare const isDraft: ({ filepath, filename }: Partial<File>) => boolean;
@@ -20,7 +20,7 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
20
20
  return r;
21
21
  };
22
22
  Object.defineProperty(exports, "__esModule", { value: true });
23
- 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;
23
+ exports.isDraft = exports.canFeedback = 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;
24
24
  var model_base_1 = require("../../db/model.base");
25
25
  exports.mb = 1048576;
26
26
  exports.MAX_SIZE = 2;
@@ -190,6 +190,14 @@ exports.canSubmit = function (file, user) {
190
190
  return submitStatuses.includes(file.status) &&
191
191
  !file.userValidatedAt && (exports.isOwner(file, user) || exports.isAuthorized(file, user));
192
192
  };
193
+ var feedbackStatuses = [
194
+ FileStatus.validateDataDone,
195
+ FileError.validateDataError
196
+ ];
197
+ exports.canFeedback = function (_a) {
198
+ var status = _a.status;
199
+ return feedbackStatuses.includes(status);
200
+ };
193
201
  exports.isDraft = function (_a) {
194
202
  var filepath = _a.filepath, filename = _a.filename;
195
203
  return (filepath || filename || '').endsWith(SupportedExtensions.draft);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hestia-earth/api",
3
- "version": "0.10.1",
3
+ "version": "0.11.0",
4
4
  "description": "Hestia API definitions",
5
5
  "main": "dist/models.js",
6
6
  "typings": "dist/models.d.ts",