@hestia-earth/api 0.28.12 → 0.28.13

package/esm/models.js

@@ -11,6 +11,7 @@ export * from './glossary/model/model.js';
 export * from './migrations/model/model.js';
 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/model.js';
 export * from './url-shortener/model/model.js';

package/esm/reports/model.js

@@ -0,0 +1,13 @@
+const reportOptionKeys = [
+    'product',
+    'limit',
+    'feedback',
+    'narrativeModel',
+    'format',
+    'noNarrative',
+    'noBenchmark',
+    'noContributions',
+    'radar',
+    'refetch'
+];
+export const reportOptionsFromBody = (body = {}) => reportOptionKeys.reduce((acc, key) => (body[key] === undefined ? acc : { ...acc, [key]: body[key] }), {});

package/esm/users/model/model.js

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

package/models.d.ts

@@ -11,6 +11,7 @@ export * from './glossary/model/model';
 export * from './migrations/model/model';
 export * from './nodes/model/model';
 export * from './reconciliations/model/model';
+export * from './reports/model';
 export * from './settings/model/model';
 export * from './source-tracker/model/model';
 export * from './url-shortener/model/model';

package/models.js

@@ -27,6 +27,7 @@ __exportStar(require("./glossary/model/model"), exports);
 __exportStar(require("./migrations/model/model"), exports);
 __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/model"), exports);
 __exportStar(require("./url-shortener/model/model"), exports);

package/package.json

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

package/reports/model.d.ts

@@ -0,0 +1,24 @@
+import { NodeType } from '@hestia-earth/schema';
+export interface ReportNode {
+    '@type': NodeType;
+    '@id': string;
+}
+export interface ReportOptions {
+    product?: string;
+    limit?: number;
+    feedback?: string;
+    narrativeModel?: string;
+    format?: string | string[];
+    noNarrative?: boolean;
+    noBenchmark?: boolean;
+    noContributions?: boolean;
+    radar?: boolean;
+    refetch?: boolean;
+}
+export interface ReportParams extends ReportOptions {
+    fileId?: string;
+    sourceId?: string;
+    nodes?: ReportNode[];
+    dataVersion?: string;
+}
+export declare const reportOptionsFromBody: (body?: ReportOptions) => ReportOptions;

package/reports/model.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportOptionsFromBody = void 0;
+const reportOptionKeys = [
+    'product',
+    'limit',
+    'feedback',
+    'narrativeModel',
+    'format',
+    'noNarrative',
+    'noBenchmark',
+    'noContributions',
+    'radar',
+    'refetch'
+];
+const reportOptionsFromBody = (body = {}) => reportOptionKeys.reduce((acc, key) => (body[key] === undefined ? acc : { ...acc, [key]: body[key] }), {});
+exports.reportOptionsFromBody = reportOptionsFromBody;

package/users/model/model.d.ts

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

package/users/model/model.js

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