@hestia-earth/api 0.28.22 → 0.28.24

package/esm/models.js

@@ -13,6 +13,7 @@ export * from './nodes/model/model.js';
 export * from './reconciliations/model/model.js';
 export * from './reports/model.js';
 export * from './settings/model/model.js';
+export * from './source-tracker/model/lit-review.model.js';
 export * from './source-tracker/model/model.js';
 export * from './url-shortener/model/model.js';
 export * from './users/model/model.js';

package/esm/source-tracker/model/lit-review.document.js

@@ -0,0 +1 @@
+export {};

package/esm/source-tracker/model/lit-review.model.js

@@ -0,0 +1,49 @@
+export var LitReviewStatus;
+(function (LitReviewStatus) {
+    LitReviewStatus["Queued"] = "queued";
+    LitReviewStatus["Running"] = "running";
+    LitReviewStatus["Succeeded"] = "succeeded";
+    LitReviewStatus["Failed"] = "failed";
+})(LitReviewStatus || (LitReviewStatus = {}));
+export var LitReviewStep;
+(function (LitReviewStep) {
+    LitReviewStep["Scope"] = "scope";
+    LitReviewStep["Snapshot"] = "snapshot";
+    LitReviewStep["Fetch"] = "fetch";
+    LitReviewStep["Screen"] = "screen";
+    LitReviewStep["Report"] = "report";
+})(LitReviewStep || (LitReviewStep = {}));
+export var LitReviewAnswer;
+(function (LitReviewAnswer) {
+    LitReviewAnswer["Yes"] = "yes";
+    LitReviewAnswer["No"] = "no";
+    LitReviewAnswer["Unknown"] = "unknown";
+})(LitReviewAnswer || (LitReviewAnswer = {}));
+export var LitReviewConfidence;
+(function (LitReviewConfidence) {
+    LitReviewConfidence["Strong"] = "A strong";
+    LitReviewConfidence["Probable"] = "B probable";
+    LitReviewConfidence["Possible"] = "C possible";
+})(LitReviewConfidence || (LitReviewConfidence = {}));
+export const LIT_REVIEW_TERMINAL_STATUSES = [LitReviewStatus.Succeeded, LitReviewStatus.Failed];
+export const isLitReviewTerminal = (status) => LIT_REVIEW_TERMINAL_STATUSES.includes(status);
+export const LIT_REVIEW_STALLED_AFTER = 30 * 60 * 1000;
+const lastWriteAt = (job) => job.progress?.heartbeatAt || job.updatedAt || job.createdAt;
+export const isLitReviewStalled = (job, now = new Date()) => {
+    const last = lastWriteAt(job);
+    const silent = last && now.getTime() - new Date(last).getTime() > LIT_REVIEW_STALLED_AFTER;
+    return !isLitReviewTerminal(job.status) && !!silent;
+};
+const armTotals = (arms) => arms.reduce((acc, { fetched, total }) => ({ fetched: acc.fetched + (fetched || 0), total: acc.total + (total || 0) }), { fetched: 0, total: 0 });
+export const litReviewPercent = (progress) => {
+    const { fetched, total } = armTotals(progress?.arms || []);
+    return total > 0 ? Math.min(fetched / total, 1) : undefined;
+};
+export const litReviewAnswer = (value) => {
+    const normalized = `${value ?? ''}`.trim().toLowerCase();
+    return normalized === LitReviewAnswer.Yes
+        ? LitReviewAnswer.Yes
+        : normalized === LitReviewAnswer.No
+            ? LitReviewAnswer.No
+            : LitReviewAnswer.Unknown;
+};

package/esm/ws.model.js

@@ -3,4 +3,5 @@ export var SocketNamespace;
     SocketNamespace["aggregation"] = "aggregation";
     SocketNamespace["file"] = "file";
     SocketNamespace["draft"] = "draft";
+    SocketNamespace["litReview"] = "litReview";
 })(SocketNamespace || (SocketNamespace = {}));

package/models.d.ts

@@ -13,6 +13,7 @@ export * from './nodes/model/model';
 export * from './reconciliations/model/model';
 export * from './reports/model';
 export * from './settings/model/model';
+export * from './source-tracker/model/lit-review.model';
 export * from './source-tracker/model/model';
 export * from './url-shortener/model/model';
 export * from './users/model/model';

package/models.js

@@ -29,6 +29,7 @@ __exportStar(require("./nodes/model/model"), exports);
 __exportStar(require("./reconciliations/model/model"), exports);
 __exportStar(require("./reports/model"), exports);
 __exportStar(require("./settings/model/model"), exports);
+__exportStar(require("./source-tracker/model/lit-review.model"), exports);
 __exportStar(require("./source-tracker/model/model"), exports);
 __exportStar(require("./url-shortener/model/model"), exports);
 __exportStar(require("./users/model/model"), exports);

package/package.json

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

package/source-tracker/model/lit-review.document.d.ts

@@ -0,0 +1,4 @@
+import { LitReview } from './lit-review.model';
+import { IMongooseDocument } from '../../db/mongoose.model';
+export interface ILitReviewDocument extends LitReview, IMongooseDocument {
+}

package/source-tracker/model/lit-review.document.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/source-tracker/model/lit-review.model.d.ts

@@ -0,0 +1,101 @@
+import { BaseModel } from '../../db/model.base';
+export declare enum LitReviewStatus {
+    Queued = "queued",
+    Running = "running",
+    Succeeded = "succeeded",
+    Failed = "failed"
+}
+export declare enum LitReviewStep {
+    Scope = "scope",
+    Snapshot = "snapshot",
+    Fetch = "fetch",
+    Screen = "screen",
+    Report = "report"
+}
+export declare enum LitReviewAnswer {
+    Yes = "yes",
+    No = "no",
+    Unknown = "unknown"
+}
+export interface LitReviewScope {
+    crop?: string;
+    country?: string;
+    practice?: string;
+    years?: string;
+    freeText?: string;
+    anchorPractice?: boolean;
+}
+export interface LitReviewArm {
+    name: string;
+    fetched?: number;
+    total?: number;
+    done?: boolean;
+}
+export interface LitReviewProgress {
+    step?: LitReviewStep;
+    arms?: LitReviewArm[];
+    attempt?: number;
+    message?: string;
+    heartbeatAt?: Date;
+}
+export interface LitReview extends BaseModel {
+    status: LitReviewStatus;
+    scope: LitReviewScope;
+    scopeSummary?: string;
+    progress?: LitReviewProgress;
+    counts?: {
+        [tier: string]: number;
+    };
+    error?: string;
+    startedAt?: Date;
+    completedAt?: Date;
+    createdBy?: string;
+}
+export declare enum LitReviewConfidence {
+    Strong = "A strong",
+    Probable = "B probable",
+    Possible = "C possible"
+}
+export interface LitReviewStudy {
+    rank?: number;
+    cellPriority?: string;
+    confidence?: string;
+    crop?: string;
+    country?: string;
+    title?: string;
+    year?: number;
+    doi?: string;
+    url?: string;
+    studyDesign?: string;
+    reportsYield: LitReviewAnswer;
+    reportsFertiliser: LitReviewAnswer;
+    farmLevel?: boolean;
+    lcaFraming?: boolean;
+    openAccess?: boolean;
+    pdfUrl?: string;
+    practiceEvidence?: string;
+    venue?: string;
+    firstAuthor?: string;
+    citedBy?: number;
+    hasAbstract?: boolean;
+    foundBy?: string;
+    studyKey?: string;
+    studyPath?: string;
+    fields: {
+        [column: string]: string;
+    };
+}
+export interface LitReviewFiles {
+    workbookPath?: string;
+    logPath?: string;
+    scopePath?: string;
+    csvPaths: {
+        [filename: string]: string;
+    };
+}
+export declare const LIT_REVIEW_TERMINAL_STATUSES: LitReviewStatus[];
+export declare const isLitReviewTerminal: (status?: LitReviewStatus) => boolean;
+export declare const LIT_REVIEW_STALLED_AFTER: number;
+export declare const isLitReviewStalled: (job: Pick<LitReview, "status" | "progress" | "updatedAt" | "createdAt">, now?: Date) => boolean;
+export declare const litReviewPercent: (progress?: LitReviewProgress) => number;
+export declare const litReviewAnswer: (value?: string) => LitReviewAnswer;

package/source-tracker/model/lit-review.model.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.litReviewAnswer = exports.litReviewPercent = exports.isLitReviewStalled = exports.LIT_REVIEW_STALLED_AFTER = exports.isLitReviewTerminal = exports.LIT_REVIEW_TERMINAL_STATUSES = exports.LitReviewConfidence = exports.LitReviewAnswer = exports.LitReviewStep = exports.LitReviewStatus = void 0;
+var LitReviewStatus;
+(function (LitReviewStatus) {
+    LitReviewStatus["Queued"] = "queued";
+    LitReviewStatus["Running"] = "running";
+    LitReviewStatus["Succeeded"] = "succeeded";
+    LitReviewStatus["Failed"] = "failed";
+})(LitReviewStatus || (exports.LitReviewStatus = LitReviewStatus = {}));
+var LitReviewStep;
+(function (LitReviewStep) {
+    LitReviewStep["Scope"] = "scope";
+    LitReviewStep["Snapshot"] = "snapshot";
+    LitReviewStep["Fetch"] = "fetch";
+    LitReviewStep["Screen"] = "screen";
+    LitReviewStep["Report"] = "report";
+})(LitReviewStep || (exports.LitReviewStep = LitReviewStep = {}));
+var LitReviewAnswer;
+(function (LitReviewAnswer) {
+    LitReviewAnswer["Yes"] = "yes";
+    LitReviewAnswer["No"] = "no";
+    LitReviewAnswer["Unknown"] = "unknown";
+})(LitReviewAnswer || (exports.LitReviewAnswer = LitReviewAnswer = {}));
+var LitReviewConfidence;
+(function (LitReviewConfidence) {
+    LitReviewConfidence["Strong"] = "A strong";
+    LitReviewConfidence["Probable"] = "B probable";
+    LitReviewConfidence["Possible"] = "C possible";
+})(LitReviewConfidence || (exports.LitReviewConfidence = LitReviewConfidence = {}));
+exports.LIT_REVIEW_TERMINAL_STATUSES = [LitReviewStatus.Succeeded, LitReviewStatus.Failed];
+const isLitReviewTerminal = (status) => exports.LIT_REVIEW_TERMINAL_STATUSES.includes(status);
+exports.isLitReviewTerminal = isLitReviewTerminal;
+exports.LIT_REVIEW_STALLED_AFTER = 30 * 60 * 1000;
+const lastWriteAt = (job) => job.progress?.heartbeatAt || job.updatedAt || job.createdAt;
+const isLitReviewStalled = (job, now = new Date()) => {
+    const last = lastWriteAt(job);
+    const silent = last && now.getTime() - new Date(last).getTime() > exports.LIT_REVIEW_STALLED_AFTER;
+    return !(0, exports.isLitReviewTerminal)(job.status) && !!silent;
+};
+exports.isLitReviewStalled = isLitReviewStalled;
+const armTotals = (arms) => arms.reduce((acc, { fetched, total }) => ({ fetched: acc.fetched + (fetched || 0), total: acc.total + (total || 0) }), { fetched: 0, total: 0 });
+const litReviewPercent = (progress) => {
+    const { fetched, total } = armTotals(progress?.arms || []);
+    return total > 0 ? Math.min(fetched / total, 1) : undefined;
+};
+exports.litReviewPercent = litReviewPercent;
+const litReviewAnswer = (value) => {
+    const normalized = `${value ?? ''}`.trim().toLowerCase();
+    return normalized === LitReviewAnswer.Yes
+        ? LitReviewAnswer.Yes
+        : normalized === LitReviewAnswer.No
+            ? LitReviewAnswer.No
+            : LitReviewAnswer.Unknown;
+};
+exports.litReviewAnswer = litReviewAnswer;

package/source-tracker/model/model.d.ts

@@ -54,5 +54,6 @@ export interface SourceTracker extends BaseModel {
     notes?: string;
     createdBy?: string;
     study?: BaseFile;
+    studyError?: string;
     supplementary?: BaseFile[];
 }

package/ws.model.d.ts

@@ -1,5 +1,6 @@
 export declare enum SocketNamespace {
     aggregation = "aggregation",
     file = "file",
-    draft = "draft"
+    draft = "draft",
+    litReview = "litReview"
 }

package/ws.model.js

@@ -6,4 +6,5 @@ var SocketNamespace;
     SocketNamespace["aggregation"] = "aggregation";
     SocketNamespace["file"] = "file";
     SocketNamespace["draft"] = "draft";
+    SocketNamespace["litReview"] = "litReview";
 })(SocketNamespace || (exports.SocketNamespace = SocketNamespace = {}));