@hestia-earth/api 0.26.11 → 0.26.13

package/esm/files/model/model.js

@@ -12,14 +12,24 @@ export var SupportedExtensions;
     SupportedExtensions["json"] = "json";
     SupportedExtensions["draft"] = "txt";
     SupportedExtensions["pdf"] = "pdf";
+    SupportedExtensions["md"] = "md";
 })(SupportedExtensions || (SupportedExtensions = {}));
+export const studyExtensions = [SupportedExtensions.pdf];
+export const supplementaryExtensions = [
+    SupportedExtensions.pdf,
+    SupportedExtensions.xlsx,
+    SupportedExtensions.xls,
+    SupportedExtensions.csv,
+    SupportedExtensions.md
+];
 const maxFileSizeExt = {
     [SupportedExtensions.csv]: maxFileSize,
     [SupportedExtensions.xlsx]: maxFileSize / 2,
     [SupportedExtensions.xls]: maxFileSize / 2,
     [SupportedExtensions.draft]: maxFileSize,
     [SupportedExtensions.json]: maxFileSize,
-    [SupportedExtensions.pdf]: maxFileSize / 2
+    [SupportedExtensions.pdf]: maxFileSize / 2,
+    [SupportedExtensions.md]: maxFileSize
 };
 export const maxFileSizeByFile = (filename) => maxFileSizeExt[fileExt(filename).replace('.', '')];
 export const finalFormatExtensions = [SupportedExtensions.json, SupportedExtensions.csv];
@@ -104,14 +114,16 @@ export var FileValidationStatus;
     FileValidationStatus["success"] = "success";
     FileValidationStatus["error"] = "error";
 })(FileValidationStatus || (FileValidationStatus = {}));
-export class File extends BaseModel {
+export class BaseFile extends BaseModel {
     filename;
     filepath;
+    contentType;
+}
+export class File extends BaseFile {
     folder;
     user;
     assignedUsers;
     authorizedUsers;
-    contentType;
     archived;
     status;
     pipelineStatus;
@@ -128,6 +140,9 @@ export class File extends BaseModel {
     isPrivate;
     skipValidation;
     study;
+    supplementary;
+    extraction;
+    extractionLogs;
     fromDraft;
     deleted;
     isOwner;
@@ -139,6 +154,7 @@ export class File extends BaseModel {
     hestiaPath;
     progressPath;
     studyPath;
+    supplementaryPaths;
     dataPath;
     dataProgressPath;
     dataCsvPath;

package/esm/users/model/model.js

@@ -27,6 +27,7 @@ export var UserPermission;
     UserPermission["reconciliationsRead"] = "reconciliations-view";
     UserPermission["reconciliationsUpdate"] = "reconciliations-update";
     UserPermission["reconciliationsDelete"] = "reconciliations-delete";
+    UserPermission["filesPdfExtract"] = "files-pdf-extract";
 })(UserPermission || (UserPermission = {}));
 export var UserPermissionRequestStatus;
 (function (UserPermissionRequestStatus) {

package/files/model/model.d.ts

@@ -11,8 +11,11 @@ export declare enum SupportedExtensions {
     csv = "csv",
     json = "json",
     draft = "txt",
-    pdf = "pdf"
+    pdf = "pdf",
+    md = "md"
 }
+export declare const studyExtensions: SupportedExtensions[];
+export declare const supplementaryExtensions: SupportedExtensions[];
 export declare const maxFileSizeByFile: (filename: string) => any;
 export declare const finalFormatExtensions: SupportedExtensions[];
 export declare enum HestiaExtensions {
@@ -106,14 +109,16 @@ export interface IFileMetadata {
     indexedNodesPerType?: Partial<Record<NodeType, number>>;
     recalculatedNodesPerType?: Partial<Record<NodeType, number>>;
 }
-export declare class File extends BaseModel {
+export declare class BaseFile extends BaseModel {
     filename: string;
     filepath: string;
+    contentType?: string;
+}
+export declare class File extends BaseFile {
     folder?: string;
     user: User;
     assignedUsers?: User[];
     authorizedUsers?: User[];
-    contentType?: string;
     archived: boolean;
     status?: status;
     pipelineStatus?: pipelineStatus;
@@ -129,7 +134,10 @@ export declare class File extends BaseModel {
     metadata?: IFileMetadata;
     isPrivate?: boolean;
     skipValidation?: boolean;
-    study?: File;
+    study?: BaseFile;
+    supplementary?: BaseFile[];
+    extraction?: boolean;
+    extractionLogs?: string;
     fromDraft?: boolean;
     deleted?: boolean;
     readonly isOwner?: boolean;
@@ -141,6 +149,7 @@ export declare class File extends BaseModel {
     readonly hestiaPath?: string;
     readonly progressPath?: string;
     readonly studyPath?: string;
+    readonly supplementaryPaths?: string[];
     readonly dataPath?: string;
     readonly dataProgressPath?: string;
     readonly dataCsvPath?: string;

package/files/model/model.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAssigned = exports.isAuthorized = exports.isOwner = 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.FileValidationStatus = exports.FilePipelineError = exports.FilePipelineProgress = exports.FilePipelineStatus = exports.FileError = exports.FileStatus = exports.FileProgress = exports.FileFindFields = exports.HestiaExtensions = exports.finalFormatExtensions = exports.maxFileSizeByFile = 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 = void 0;
+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;
 const model_base_1 = require("../../db/model.base");
 const model_1 = require("../../users/model/model");
 exports.mb = 1048576;
@@ -17,14 +17,24 @@ var SupportedExtensions;
     SupportedExtensions["json"] = "json";
     SupportedExtensions["draft"] = "txt";
     SupportedExtensions["pdf"] = "pdf";
+    SupportedExtensions["md"] = "md";
 })(SupportedExtensions || (exports.SupportedExtensions = SupportedExtensions = {}));
+exports.studyExtensions = [SupportedExtensions.pdf];
+exports.supplementaryExtensions = [
+    SupportedExtensions.pdf,
+    SupportedExtensions.xlsx,
+    SupportedExtensions.xls,
+    SupportedExtensions.csv,
+    SupportedExtensions.md
+];
 const maxFileSizeExt = {
     [SupportedExtensions.csv]: exports.maxFileSize,
     [SupportedExtensions.xlsx]: exports.maxFileSize / 2,
     [SupportedExtensions.xls]: exports.maxFileSize / 2,
     [SupportedExtensions.draft]: exports.maxFileSize,
     [SupportedExtensions.json]: exports.maxFileSize,
-    [SupportedExtensions.pdf]: exports.maxFileSize / 2
+    [SupportedExtensions.pdf]: exports.maxFileSize / 2,
+    [SupportedExtensions.md]: exports.maxFileSize
 };
 const maxFileSizeByFile = (filename) => maxFileSizeExt[(0, exports.fileExt)(filename).replace('.', '')];
 exports.maxFileSizeByFile = maxFileSizeByFile;
@@ -110,14 +120,17 @@ var FileValidationStatus;
     FileValidationStatus["success"] = "success";
     FileValidationStatus["error"] = "error";
 })(FileValidationStatus || (exports.FileValidationStatus = FileValidationStatus = {}));
-class File extends model_base_1.BaseModel {
+class BaseFile extends model_base_1.BaseModel {
     filename;
     filepath;
+    contentType;
+}
+exports.BaseFile = BaseFile;
+class File extends BaseFile {
     folder;
     user;
     assignedUsers;
     authorizedUsers;
-    contentType;
     archived;
     status;
     pipelineStatus;
@@ -134,6 +147,9 @@ class File extends model_base_1.BaseModel {
     isPrivate;
     skipValidation;
     study;
+    supplementary;
+    extraction;
+    extractionLogs;
     fromDraft;
     deleted;
     isOwner;
@@ -145,6 +161,7 @@ class File extends model_base_1.BaseModel {
     hestiaPath;
     progressPath;
     studyPath;
+    supplementaryPaths;
     dataPath;
     dataProgressPath;
     dataCsvPath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/api",
-  "version": "0.26.11",
+  "version": "0.26.13",
   "description": "Hestia API definitions",
   "main": "models.js",
   "module": "esm/models.js",
@@ -39,6 +39,6 @@
   "dependencies": {
     "@hestia-earth/json-schema": ">=37.0.0",
     "@hestia-earth/schema": ">=37.0.0",
-    "@hestia-earth/utils": ">=0.15.0"
+    "@hestia-earth/utils": "^0.17.17"
   }
 }

package/users/model/model.d.ts

@@ -22,7 +22,8 @@ export declare enum UserPermission {
     reconciliationsCreate = "reconciliations-create",
     reconciliationsRead = "reconciliations-view",
     reconciliationsUpdate = "reconciliations-update",
-    reconciliationsDelete = "reconciliations-delete"
+    reconciliationsDelete = "reconciliations-delete",
+    filesPdfExtract = "files-pdf-extract"
 }
 export declare enum UserPermissionRequestStatus {
     Approved = "approved",

package/users/model/model.js

@@ -30,6 +30,7 @@ var UserPermission;
     UserPermission["reconciliationsRead"] = "reconciliations-view";
     UserPermission["reconciliationsUpdate"] = "reconciliations-update";
     UserPermission["reconciliationsDelete"] = "reconciliations-delete";
+    UserPermission["filesPdfExtract"] = "files-pdf-extract";
 })(UserPermission || (exports.UserPermission = UserPermission = {}));
 var UserPermissionRequestStatus;
 (function (UserPermissionRequestStatus) {