@hestia-earth/api 0.28.5 → 0.28.7

package/data-plan/model/document.d.ts

@@ -0,0 +1,4 @@
+import { DataPlan } from './model';
+import { IMongooseDocument } from '../../db/mongoose.model';
+export interface IDataPlanDocument extends DataPlan, IMongooseDocument {
+}

package/data-plan/model/document.js

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

package/data-plan/model/model.d.ts

@@ -0,0 +1,42 @@
+import { BaseModel } from '../../db/model.base';
+export declare enum LiteratureReviewStatus {
+    ToDo = "to-do",
+    InProgress = "in-progress",
+    Done = "done"
+}
+export declare enum DataPlanQuality {
+    Low = "low",
+    Medium = "medium",
+    High = "high"
+}
+export type QualityRank = 1 | 2 | 3;
+export declare const QUALITY_RANK: Record<DataPlanQuality, QualityRank>;
+export declare const QUALITY_RANKS: QualityRank[];
+export declare enum AggregationCriterion {
+    EmissionsIncluded = "emissions-included",
+    NumberOfCycles = "number-of-cycles",
+    YieldDelta = "yield-delta",
+    Completeness = "completeness",
+    ProductionCoverage = "production-coverage"
+}
+export interface DataPlan extends BaseModel {
+    product: string;
+    country: string;
+    periodStart: number;
+    periodEnd: number;
+    literatureReviewStatus?: LiteratureReviewStatus;
+    aggregationNotes?: string;
+    expectedVersionId?: string;
+    expectedQuality?: QualityRank;
+    gitlabIssue?: string;
+    assigneeId?: string;
+    targetDate?: Date;
+    aggregationId?: string | null;
+    releasedQuality?: QualityRank | null;
+    nonVerifiedQuality?: QualityRank | null;
+    unmetCriteria?: AggregationCriterion[];
+    suitableSourcesCount?: number | null;
+    sourcesToUploadCount?: number | null;
+    completionPct?: number | null;
+    computedAt?: Date | null;
+}

package/data-plan/model/model.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AggregationCriterion = exports.QUALITY_RANKS = exports.QUALITY_RANK = exports.DataPlanQuality = exports.LiteratureReviewStatus = void 0;
+var LiteratureReviewStatus;
+(function (LiteratureReviewStatus) {
+    LiteratureReviewStatus["ToDo"] = "to-do";
+    LiteratureReviewStatus["InProgress"] = "in-progress";
+    LiteratureReviewStatus["Done"] = "done";
+})(LiteratureReviewStatus || (exports.LiteratureReviewStatus = LiteratureReviewStatus = {}));
+var DataPlanQuality;
+(function (DataPlanQuality) {
+    DataPlanQuality["Low"] = "low";
+    DataPlanQuality["Medium"] = "medium";
+    DataPlanQuality["High"] = "high";
+})(DataPlanQuality || (exports.DataPlanQuality = DataPlanQuality = {}));
+exports.QUALITY_RANK = {
+    [DataPlanQuality.Low]: 1,
+    [DataPlanQuality.Medium]: 2,
+    [DataPlanQuality.High]: 3
+};
+exports.QUALITY_RANKS = [1, 2, 3];
+var AggregationCriterion;
+(function (AggregationCriterion) {
+    AggregationCriterion["EmissionsIncluded"] = "emissions-included";
+    AggregationCriterion["NumberOfCycles"] = "number-of-cycles";
+    AggregationCriterion["YieldDelta"] = "yield-delta";
+    AggregationCriterion["Completeness"] = "completeness";
+    AggregationCriterion["ProductionCoverage"] = "production-coverage";
+})(AggregationCriterion || (exports.AggregationCriterion = AggregationCriterion = {}));

package/data-plan/model/version.document.d.ts

@@ -0,0 +1,4 @@
+import { DataPlanVersion } from './version.model';
+import { IMongooseDocument } from '../../db/mongoose.model';
+export interface IDataPlanVersionDocument extends DataPlanVersion, IMongooseDocument {
+}

package/data-plan/model/version.document.js

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

package/data-plan/model/version.model.d.ts

@@ -0,0 +1,4 @@
+import { BaseModel } from '../../db/model.base';
+export interface DataPlanVersion extends BaseModel {
+    name: string;
+}

package/data-plan/model/version.model.js

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

package/esm/data-plan/model/document.js

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

package/esm/data-plan/model/model.js

@@ -0,0 +1,26 @@
+export var LiteratureReviewStatus;
+(function (LiteratureReviewStatus) {
+    LiteratureReviewStatus["ToDo"] = "to-do";
+    LiteratureReviewStatus["InProgress"] = "in-progress";
+    LiteratureReviewStatus["Done"] = "done";
+})(LiteratureReviewStatus || (LiteratureReviewStatus = {}));
+export var DataPlanQuality;
+(function (DataPlanQuality) {
+    DataPlanQuality["Low"] = "low";
+    DataPlanQuality["Medium"] = "medium";
+    DataPlanQuality["High"] = "high";
+})(DataPlanQuality || (DataPlanQuality = {}));
+export const QUALITY_RANK = {
+    [DataPlanQuality.Low]: 1,
+    [DataPlanQuality.Medium]: 2,
+    [DataPlanQuality.High]: 3
+};
+export const QUALITY_RANKS = [1, 2, 3];
+export var AggregationCriterion;
+(function (AggregationCriterion) {
+    AggregationCriterion["EmissionsIncluded"] = "emissions-included";
+    AggregationCriterion["NumberOfCycles"] = "number-of-cycles";
+    AggregationCriterion["YieldDelta"] = "yield-delta";
+    AggregationCriterion["Completeness"] = "completeness";
+    AggregationCriterion["ProductionCoverage"] = "production-coverage";
+})(AggregationCriterion || (AggregationCriterion = {}));

package/esm/data-plan/model/version.document.js

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

package/esm/data-plan/model/version.model.js

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

package/esm/models.js

@@ -2,6 +2,7 @@ export * from './api-calls/model/model.js';
 export * from './aggregations/model/model.js';
 export * from './analyses/model/model.js';
 export * from './cycles/model/model.js';
+export * from './data-plan/model/model.js';
 export * from './drafts/model/model.js';
 export * from './earth-engine/model/model.js';
 export * from './files/model/llm-preset.js';

package/models.d.ts

@@ -2,6 +2,7 @@ export * from './api-calls/model/model';
 export * from './aggregations/model/model';
 export * from './analyses/model/model';
 export * from './cycles/model/model';
+export * from './data-plan/model/model';
 export * from './drafts/model/model';
 export * from './earth-engine/model/model';
 export * from './files/model/llm-preset';

package/models.js

@@ -18,6 +18,7 @@ __exportStar(require("./api-calls/model/model"), exports);
 __exportStar(require("./aggregations/model/model"), exports);
 __exportStar(require("./analyses/model/model"), exports);
 __exportStar(require("./cycles/model/model"), exports);
+__exportStar(require("./data-plan/model/model"), exports);
 __exportStar(require("./drafts/model/model"), exports);
 __exportStar(require("./earth-engine/model/model"), exports);
 __exportStar(require("./files/model/llm-preset"), exports);

package/package.json

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

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

@@ -48,6 +48,7 @@ export interface SourceTracker extends BaseModel {
     gitlabMatchNeedsReview: boolean;
     gitlabRejectedIssueIids?: number[];
     hestiaEnrichment?: SourceTrackerEnrichment;
+    fileId?: string;
     notes?: string;
     createdBy?: string;
     study?: BaseFile;