@hestia-earth/api 0.28.41 → 0.28.43

package/esm/files/model/model.js

@@ -148,6 +148,7 @@ export class File extends BaseFile {
     datasetUrl;
     extractionLogs;
     extractionNotes;
+    versions;
     manuallyEditedAt;
     fromDraft;
     deleted;
@@ -262,6 +263,8 @@ export const canSubmit = (file, user) => !file.archived &&
     !file.userValidatedAt &&
     (isOwner(file, user) || isAuthorized(file, user));
 export const isDraft = ({ filepath, filename }) => (filepath || filename || '').endsWith(SupportedExtensions.draft);
+export const isOwnReview = (review, user) => asString(review?.user) === asString(user);
+export const formatReviews = (reviewed = [], user) => reviewed.map(review => ({ id: review.id, date: review.date, isMine: isOwnReview(review, user) }));
 export const canEditComment = (comment, user) => asString(comment?.user) === asString(user);
 export const canCommitHestiaData = (file, user) => !file.archived && isValidated(file) && (isReviewer(user) || user?.canCommitHestiaData);
 const grantAccessByRole = {

package/files/model/model.d.ts

@@ -116,6 +116,29 @@ export interface IExtractionNote {
     quote?: string;
     nodes?: IExtractionNoteNode[];
 }
+export interface IFileVersionSummary {
+    changes?: number;
+    applied?: number;
+    declined?: number;
+    unaddressed?: number;
+    unrequested?: number;
+    cells?: number;
+}
+export interface IFileVersionReview {
+    id: string;
+    user: User;
+    date: Date;
+    readonly isMine?: boolean;
+}
+export interface IFileVersion {
+    version: number;
+    createdAt: Date;
+    commentIds?: string[];
+    summary?: IFileVersionSummary;
+    reviewed?: IFileVersionReview[];
+    key?: string;
+    readonly changesPath?: string;
+}
 export interface IFileMetadata {
     slackThreadTs?: string;
     nodesPerType?: Partial<Record<NodeType, number>>;
@@ -153,6 +176,7 @@ export declare class File extends BaseFile {
     datasetUrl?: string;
     extractionLogs?: string;
     extractionNotes?: IExtractionNote[];
+    versions?: IFileVersion[];
     manuallyEditedAt?: Date;
     fromDraft?: boolean;
     deleted?: boolean;
@@ -229,6 +253,8 @@ export declare const canValidate: ({ status, isPrivate, archived }: Partial<File
 export declare const isValidated: ({ validatedAt, status }: Partial<File>) => boolean;
 export declare const canSubmit: (file: Partial<File>, user: User) => boolean;
 export declare const isDraft: ({ filepath, filename }: Partial<File>) => boolean;
+export declare const isOwnReview: (review: IFileVersionReview, user: User) => boolean;
+export declare const formatReviews: (reviewed: IFileVersionReview[], user: User) => IFileVersionReview[];
 export declare const canEditComment: (comment: IFileComment, user: User) => boolean;
 export declare const canCommitHestiaData: (file: File, user: User) => boolean;
 export declare const hasAccess: (file: File, user: User, allowedRoles: UserRole[]) => boolean;

package/files/model/model.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.userFolder = exports.isFolderUpload = exports.isAdminFolder = exports.isAggregation = exports.aggregationFolder = exports.isTerm = exports.isGlossary = exports.hasReconciliationAccess = exports.isReconciliation = exports.isAnalysis = exports.reconciliationFolder = exports.termFolder = exports.glossaryFolder = exports.analysesFolder = exports.filenameFromPath = exports.rootFolderFromPath = exports.folderFromPath = exports.normalizeFolder = exports.isFilepathValid = exports.isFilenameValid = exports.canUploadFolderFile = exports.canUseFolder = exports.replaceInvalidChars = exports.validPathChars = exports.filenameWithoutExt = exports.fileToExt = exports.isSupportedExt = exports.fileExt = exports.filepathSearch = exports.filenameSearch = exports.File = exports.BaseFile = exports.FileValidationStatus = exports.FilePipelineError = exports.FilePipelineProgress = exports.FilePipelineStatus = exports.FileError = exports.FileStatus = exports.FileProgress = exports.FileFindFields = exports.HestiaExtensions = exports.finalFormatExtensions = exports.maxFileSizeByFile = exports.supplementaryExtensions = exports.studyExtensions = exports.SupportedExtensions = exports.maxFileSize = exports.maxFileSizeMb = exports.sizeInMb = exports.mb = void 0;
-exports.hasAccess = exports.canCommitHestiaData = exports.canEditComment = exports.isDraft = exports.canSubmit = exports.isValidated = exports.canValidate = exports.validatedStatuses = exports.canRemove = exports.canForceRemove = exports.isLocked = exports.isAssigned = exports.isAuthorized = exports.isOwner = void 0;
+exports.hasAccess = exports.canCommitHestiaData = exports.canEditComment = exports.formatReviews = exports.isOwnReview = exports.isDraft = exports.canSubmit = exports.isValidated = exports.canValidate = exports.validatedStatuses = exports.canRemove = exports.canForceRemove = exports.isLocked = exports.isAssigned = exports.isAuthorized = exports.isOwner = void 0;
 const model_base_1 = require("../../db/model.base");
 const model_1 = require("../../users/model/model");
 exports.mb = 1048576;
@@ -155,6 +155,7 @@ class File extends BaseFile {
     datasetUrl;
     extractionLogs;
     extractionNotes;
+    versions;
     manuallyEditedAt;
     fromDraft;
     deleted;
@@ -304,6 +305,10 @@ const canSubmit = (file, user) => !file.archived &&
 exports.canSubmit = canSubmit;
 const isDraft = ({ filepath, filename }) => (filepath || filename || '').endsWith(SupportedExtensions.draft);
 exports.isDraft = isDraft;
+const isOwnReview = (review, user) => asString(review?.user) === asString(user);
+exports.isOwnReview = isOwnReview;
+const formatReviews = (reviewed = [], user) => reviewed.map(review => ({ id: review.id, date: review.date, isMine: (0, exports.isOwnReview)(review, user) }));
+exports.formatReviews = formatReviews;
 const canEditComment = (comment, user) => asString(comment?.user) === asString(user);
 exports.canEditComment = canEditComment;
 const canCommitHestiaData = (file, user) => !file.archived && (0, exports.isValidated)(file) && ((0, model_1.isReviewer)(user) || user?.canCommitHestiaData);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/api",
-  "version": "0.28.41",
+  "version": "0.28.43",
   "description": "Hestia API definitions",
   "main": "models.js",
   "module": "esm/models.js",