@hestia-earth/api 0.28.13 → 0.28.14

package/esm/files/model/llm-preset.js

@@ -52,8 +52,10 @@ const validateConfig = (config) => {
     isStringRecord(config) || invalid('config must be an object');
     validateEngine('engine', config.engine);
     validateEngine('fixEngine', config.fixEngine);
+    validateEngine('narrativeProvider', config.narrativeProvider);
     validateOptionalString('model', config.model);
     validateOptionalString('fixModel', config.fixModel);
+    validateOptionalString('narrativeModel', config.narrativeModel);
     validateReviewerList('reviewers', config.reviewers);
     validateReviewerList('pdfConversion', config.pdfConversion);
     validateApiKeys(config.apiKeys);

package/esm/files/model/model.js

@@ -169,6 +169,7 @@ export class File extends BaseFile {
     nbCycles;
     nbImpactAssessments;
     hestiaDataPath;
+    report;
 }
 const fileNoExtSearch = (key, ...parts) => {
     const [filepathNoExt] = parts.filter(Boolean).join('/').split('.');

package/esm/reports/model.js

@@ -2,7 +2,6 @@ const reportOptionKeys = [
     'product',
     'limit',
     'feedback',
-    'narrativeModel',
     'format',
     'noNarrative',
     'noBenchmark',
@@ -11,3 +10,14 @@ const reportOptionKeys = [
     'refetch'
 ];
 export const reportOptionsFromBody = (body = {}) => reportOptionKeys.reduce((acc, key) => (body[key] === undefined ? acc : { ...acc, [key]: body[key] }), {});
+export const reportNarrativeFromPreset = ({ narrativeProvider, narrativeModel } = {}) => ({
+    ...(narrativeProvider ? { narrativeProvider } : {}),
+    ...(narrativeModel ? { narrativeModel } : {})
+});
+export const REPORT_FORMATS = ['pdf', 'docx', 'html'];
+export const REPORT_SUPPLEMENTARY_FILENAME = 'report-supplementary.xlsx';
+const reportMainRegExp = new RegExp(`^report\\.(${REPORT_FORMATS.join('|')})$`);
+export const reportKeyPrefix = (subjectId) => `${subjectId}/`;
+const reportFilename = (key) => key.split('/').pop() || '';
+export const reportMainFormat = (key) => reportFilename(key).match(reportMainRegExp)?.[1];
+export const isReportSupplementary = (key) => reportFilename(key) === REPORT_SUPPLEMENTARY_FILENAME;

package/files/model/llm-preset.d.ts

@@ -27,6 +27,8 @@ export interface LlmPresetConfig {
     pdfConversion?: LlmReviewer[];
     fixEngine?: LlmEngine;
     fixModel?: string;
+    narrativeProvider?: LlmEngine;
+    narrativeModel?: string;
     apiKeys?: Partial<Record<LlmApiKey, string>>;
 }
 export interface LlmPreset {

package/files/model/llm-preset.js

@@ -56,8 +56,10 @@ const validateConfig = (config) => {
     isStringRecord(config) || invalid('config must be an object');
     validateEngine('engine', config.engine);
     validateEngine('fixEngine', config.fixEngine);
+    validateEngine('narrativeProvider', config.narrativeProvider);
     validateOptionalString('model', config.model);
     validateOptionalString('fixModel', config.fixModel);
+    validateOptionalString('narrativeModel', config.narrativeModel);
     validateReviewerList('reviewers', config.reviewers);
     validateReviewerList('pdfConversion', config.pdfConversion);
     validateApiKeys(config.apiKeys);

package/files/model/model.d.ts

@@ -1,6 +1,7 @@
 import { ISourceJSONLD, NodeType } from '@hestia-earth/schema';
 import { BaseModel } from '../../db/model.base';
 import { User, UserRole } from '../../users/model/model';
+import { ReportFiles } from '../../reports/model';
 export declare const mb = 1048576;
 export declare const sizeInMb: (size: number) => number;
 export declare const maxFileSizeMb = 100;
@@ -162,6 +163,7 @@ export declare class File extends BaseFile {
     readonly nbCycles?: number;
     readonly nbImpactAssessments?: number;
     readonly hestiaDataPath?: string;
+    readonly report?: ReportFiles;
 }
 export declare const filenameSearch: (...parts: string[]) => {
     [x: string]: {

package/files/model/model.js

@@ -176,6 +176,7 @@ class File extends BaseFile {
     nbCycles;
     nbImpactAssessments;
     hestiaDataPath;
+    report;
 }
 exports.File = File;
 const fileNoExtSearch = (key, ...parts) => {

package/package.json

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

package/reports/model.d.ts

@@ -7,7 +7,6 @@ export interface ReportOptions {
     product?: string;
     limit?: number;
     feedback?: string;
-    narrativeModel?: string;
     format?: string | string[];
     noNarrative?: boolean;
     noBenchmark?: boolean;
@@ -15,10 +14,27 @@ export interface ReportOptions {
     radar?: boolean;
     refetch?: boolean;
 }
-export interface ReportParams extends ReportOptions {
+export interface ReportNarrative {
+    narrativeProvider?: string;
+    narrativeModel?: string;
+}
+export interface ReportParams extends ReportOptions, ReportNarrative {
     fileId?: string;
     sourceId?: string;
     nodes?: ReportNode[];
     dataVersion?: string;
 }
 export declare const reportOptionsFromBody: (body?: ReportOptions) => ReportOptions;
+export declare const reportNarrativeFromPreset: ({ narrativeProvider, narrativeModel }?: ReportNarrative) => ReportNarrative;
+export declare const REPORT_FORMATS: readonly ["pdf", "docx", "html"];
+export type ReportFormat = (typeof REPORT_FORMATS)[number];
+export declare const REPORT_SUPPLEMENTARY_FILENAME = "report-supplementary.xlsx";
+export declare const reportKeyPrefix: (subjectId: string) => string;
+export declare const reportMainFormat: (key: string) => ReportFormat | undefined;
+export declare const isReportSupplementary: (key: string) => boolean;
+export interface ReportFiles {
+    reportPaths: {
+        [format in ReportFormat]?: string;
+    };
+    supplementaryPath?: string;
+}

package/reports/model.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reportOptionsFromBody = void 0;
+exports.isReportSupplementary = exports.reportMainFormat = exports.reportKeyPrefix = exports.REPORT_SUPPLEMENTARY_FILENAME = exports.REPORT_FORMATS = exports.reportNarrativeFromPreset = exports.reportOptionsFromBody = void 0;
 const reportOptionKeys = [
     'product',
     'limit',
     'feedback',
-    'narrativeModel',
     'format',
     'noNarrative',
     'noBenchmark',
@@ -15,3 +14,18 @@ const reportOptionKeys = [
 ];
 const reportOptionsFromBody = (body = {}) => reportOptionKeys.reduce((acc, key) => (body[key] === undefined ? acc : { ...acc, [key]: body[key] }), {});
 exports.reportOptionsFromBody = reportOptionsFromBody;
+const reportNarrativeFromPreset = ({ narrativeProvider, narrativeModel } = {}) => ({
+    ...(narrativeProvider ? { narrativeProvider } : {}),
+    ...(narrativeModel ? { narrativeModel } : {})
+});
+exports.reportNarrativeFromPreset = reportNarrativeFromPreset;
+exports.REPORT_FORMATS = ['pdf', 'docx', 'html'];
+exports.REPORT_SUPPLEMENTARY_FILENAME = 'report-supplementary.xlsx';
+const reportMainRegExp = new RegExp(`^report\\.(${exports.REPORT_FORMATS.join('|')})$`);
+const reportKeyPrefix = (subjectId) => `${subjectId}/`;
+exports.reportKeyPrefix = reportKeyPrefix;
+const reportFilename = (key) => key.split('/').pop() || '';
+const reportMainFormat = (key) => reportFilename(key).match(reportMainRegExp)?.[1];
+exports.reportMainFormat = reportMainFormat;
+const isReportSupplementary = (key) => reportFilename(key) === exports.REPORT_SUPPLEMENTARY_FILENAME;
+exports.isReportSupplementary = isReportSupplementary;