@ezpaarse-project/ezreeport-sdk-js 1.3.0-rc.1 → 2.0.0-beta.1

package/dist/types-DcoMmjs3.d.ts

@@ -0,0 +1,101 @@
+interface TemplateBasicFilter {
+    /** Filter name */
+    name: string;
+    /** Should invert filter */
+    isNot?: boolean;
+    /** Field to apply filter to */
+    field: string;
+    /** Value(s) to match, if not provided, field must exist */
+    value?: string | string[];
+}
+interface TemplateRawFilter {
+    /** Filter name */
+    name: string;
+    /** Should invert filter */
+    isNot?: boolean;
+    /** Raw DSL filter */
+    raw: Record<string, unknown>;
+}
+/**
+ * A filter of a template
+ */
+type TemplateFilter = TemplateBasicFilter | TemplateRawFilter;
+/**
+ * A figure of a layout
+ */
+interface TemplateBodyFigure {
+    /** Figure type */
+    type: string;
+    /** Figure data, only used for Markdown figures */
+    data?: unknown;
+    /** Figure params, not used for Markdown figures */
+    params?: any;
+    /** Filters used when fetching data of this figure */
+    filters?: TemplateFilter[];
+    /** Slots used by this figure */
+    slots: number[];
+}
+/**
+ * Layout of a template
+ */
+interface TemplateBodyLayout {
+    /** Figures used in this layout */
+    figures: TemplateBodyFigure[];
+}
+/**
+ * Grid of a template
+ */
+interface TemplateBodyGrid {
+    /** Number of rows */
+    rows: number;
+    /** Number of columns */
+    cols: number;
+}
+/**
+ * Body of a template, this is the data used for generation
+ */
+interface TemplateBody {
+    /** Template version */
+    version?: number;
+    /** Elastic index used to create template. */
+    index?: string;
+    /** Date field of index used to generate report */
+    dateField: string;
+    /** Global filters used when fetching data */
+    filters?: TemplateFilter[];
+    /** Layouts used when rendering data */
+    layouts: TemplateBodyLayout[];
+    /** Grid used when rendering data. Default: 2x2 */
+    grid?: TemplateBodyGrid;
+}
+/**
+ * Tag of a template
+ */
+interface TemplateTag {
+    /** Tag name */
+    name: string;
+    /** Tag color. Should be in hex format */
+    color?: string;
+}
+interface Template {
+    /** Template ID */
+    id: string;
+    /** Template name */
+    name: string;
+    /** Template body */
+    body: TemplateBody;
+    /** Template tags */
+    tags?: TemplateTag[];
+    /** If template is hidden to normal users */
+    hidden?: boolean;
+    /** Creation date */
+    createdAt: Date;
+    /** Last update date */
+    updatedAt?: Date;
+}
+/**
+ * Data needed to create/edit a template
+ */
+type InputTemplate = Omit<Template, 'id' | 'createdAt' | 'updatedAt'>;
+
+export type { InputTemplate as I, Template as T, TemplateBasicFilter as a, TemplateRawFilter as b, TemplateFilter as c, TemplateBodyFigure as d, TemplateBodyLayout as e, TemplateTag as f, TemplateBodyGrid as g, TemplateBody as h };

package/dist/types-jXqGnCKQ.d.ts

@@ -0,0 +1,79 @@
+interface ReportFiles {
+    /** File containing details about the generation of report */
+    detail: string;
+    /** File containing the report */
+    report?: string;
+}
+interface ReportPeriod {
+    /** Start of the period */
+    start: Date;
+    /** End of the period */
+    end: Date;
+}
+interface RawReportPeriod {
+    start: string;
+    end: string;
+}
+interface ReportStats {
+    /** Number of page in the report */
+    pageCount: number;
+    /** Size of the report */
+    size: number;
+}
+interface ReportErrorCause {
+    /** Where the error occurred */
+    type: string;
+    /** Layout number where error occurred */
+    layout: number;
+    /** Figure number where error occurred */
+    figure?: string | number;
+}
+interface ReportDetails {
+    /** Creation date of the report */
+    createdAt: Date;
+    /** Date when the report will be destroyed */
+    destroyAt: Date;
+    /** Time taken to generate the report */
+    took: number;
+    /** Task ID used to generate the report */
+    taskId: string;
+    /** Email addresses the report was sent */
+    sendingTo?: string[];
+    /** Period used to generate report */
+    period?: ReportPeriod;
+    files: ReportFiles;
+    /** Auth used to generate the report */
+    auth: {
+        elastic: {
+            /** Elastic username used to fetch data */
+            username: string;
+        };
+    };
+    /** Stats about the report */
+    stats?: ReportStats;
+    /** Error details */
+    error?: {
+        /** Error message */
+        message: string;
+        /** Error cause */
+        cause?: ReportErrorCause;
+    };
+    /** Meta data */
+    meta?: unknown;
+}
+interface RawReportDetails extends Omit<ReportDetails, 'period' | 'createdAt' | 'destroyAt'> {
+    createdAt: string;
+    destroyAt: string;
+    period?: RawReportPeriod;
+}
+interface ReportResult {
+    /** Whether the report was successfully generated */
+    success: boolean;
+    /** Details */
+    detail: ReportDetails;
+}
+interface RawReportResult extends Omit<ReportResult, 'detail'> {
+    detail: RawReportDetails;
+}
+
+export type { ReportResult as R, ReportFiles as a, ReportErrorCause as b, ReportPeriod as c, ReportStats as d, ReportDetails as e, RawReportResult as f };

package/dist/types-y2f9Jb4M.d.ts

@@ -0,0 +1,75 @@
+import { Namespace } from './namespaces.js';
+import { e as TemplateBodyLayout, c as TemplateFilter, f as TemplateTag } from './types-DcoMmjs3.js';
+
+type TaskRecurrence = 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'BIENNIAL' | 'YEARLY';
+/**
+ * Layout of a task
+ */
+interface TaskBodyLayout extends TemplateBodyLayout {
+    /** Position where to insert this layout */
+    at: number;
+}
+/**
+ * Body of a task, this is the data used for generation
+ */
+interface TaskBody {
+    /** Task version */
+    version?: number;
+    /** Elastic index used to create task. */
+    index: string;
+    /** Date field of index used to generate report */
+    dateField?: string;
+    /** Global filters used when fetching data */
+    filters?: TemplateFilter[];
+    /** Layouts used when rendering data, added to the ones from the template. */
+    inserts: TaskBodyLayout[];
+}
+interface LastExtended {
+    /** Old template ID */
+    id: string;
+    /** Old template name */
+    name: string;
+    /** Old template tags */
+    tags: TemplateTag[];
+}
+interface Task {
+    /** Task ID */
+    id: string;
+    /** Task name */
+    name: string;
+    /** Namespace ID */
+    namespaceId: string;
+    /** Extended template ID */
+    extendedId: string;
+    /** Options to extend template */
+    template: TaskBody;
+    /** Last extended template */
+    lastExtended?: LastExtended | null;
+    /** Email addresses to send report */
+    targets: string[];
+    /** Task recurrence */
+    recurrence: TaskRecurrence;
+    /** Next run date, must be in the future */
+    nextRun: Date;
+    /** Last run date */
+    lastRun?: Date;
+    /** If task is enabled */
+    enabled: boolean;
+    /** Creation date */
+    createdAt: Date;
+    /** Last update date */
+    updatedAt?: Date;
+    /** Template extended by the task, must be included when fetching */
+    extends?: {
+        /** Template tags, must be included when fetching */
+        tags?: TemplateTag[];
+    };
+    /** Namespace of the task, must be included when fetching */
+    namespace?: Omit<Namespace, 'fetchLogin' | 'fetchOptions'>;
+}
+/**
+ * Data needed to create/edit a task
+ */
+type InputTask = Omit<Task, 'id' | 'createdAt' | 'updatedAt' | 'lastRun' | 'extends'>;
+
+export type { InputTask as I, LastExtended as L, Task as T, TaskRecurrence as a, TaskBodyLayout as b, TaskBody as c };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ezpaarse-project/ezreeport-sdk-js",
-  "version": "1.3.0-rc.1",
+  "version": "2.0.0-beta.1",
   "description": "JS SDK to communicate with ezReeport API",
   "homepage": "https://github.com/ezpaarse-project/ezreeport#readme",
   "bugs": {
@@ -13,16 +13,113 @@
   "license": "CeCILL",
   "author": "oxypomme",
   "exports": {
-    "browser": {
-      "import": "./dist/browser/ezreeport-sdk-js.mjs",
-      "require": "./dist/browser/ezreeport-sdk-js.umd.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "node": "./dist/index.js",
+      "browser": "./dist/index.mjs"
     },
-    "node": {
-      "import": "./dist/node/ezreeport-sdk-js.mjs",
-      "require": "./dist/node/ezreeport-sdk-js.js"
+    "./auth": {
+      "types": "./dist/auth.d.ts",
+      "node": "./dist/auth.js",
+      "browser": "./dist/auth.mjs"
+    },
+    "./crons": {
+      "types": "./dist/crons.d.ts",
+      "node": "./dist/crons.js",
+      "browser": "./dist/crons.mjs"
+    },
+    "./elastic": {
+      "types": "./dist/elastic.d.ts",
+      "node": "./dist/elastic.js",
+      "browser": "./dist/elastic.mjs"
+    },
+    "./health": {
+      "types": "./dist/health.d.ts",
+      "node": "./dist/health.js",
+      "browser": "./dist/health.mjs"
+    },
+    "./namespaces": {
+      "types": "./dist/namespaces.d.ts",
+      "node": "./dist/namespaces.js",
+      "browser": "./dist/namespaces.mjs"
+    },
+    "./queues": {
+      "types": "./dist/queues.d.ts",
+      "node": "./dist/queues.js",
+      "browser": "./dist/queues.mjs"
+    },
+    "./reports": {
+      "types": "./dist/reports.d.ts",
+      "node": "./dist/reports.js",
+      "browser": "./dist/reports.mjs"
+    },
+    "./tasks": {
+      "types": "./dist/tasks.d.ts",
+      "node": "./dist/tasks.js",
+      "browser": "./dist/tasks.mjs"
+    },
+    "./templates": {
+      "types": "./dist/templates.d.ts",
+      "node": "./dist/templates.js",
+      "browser": "./dist/templates.mjs"
+    },
+    "./task-activity": {
+      "types": "./dist/task-activity.d.ts",
+      "node": "./dist/task-activity.js",
+      "browser": "./dist/task-activity.mjs"
+    },
+    "./task-presets": {
+      "types": "./dist/task-presets.d.ts",
+      "node": "./dist/task-presets.js",
+      "browser": "./dist/task-presets.mjs"
+    },
+    "./helpers/aggregations": {
+      "types": "./dist/helpers/aggregations.d.ts",
+      "node": "./dist/helpers/aggregations.js",
+      "browser": "./dist/helpers/aggregations.mjs"
+    },
+    "./helpers/figures": {
+      "types": "./dist/helpers/figures.d.ts",
+      "node": "./dist/helpers/figures.js",
+      "browser": "./dist/helpers/figures.mjs"
+    },
+    "./helpers/filters": {
+      "types": "./dist/helpers/filters.d.ts",
+      "node": "./dist/helpers/filters.js",
+      "browser": "./dist/helpers/filters.mjs"
+    },
+    "./helpers/jobs": {
+      "types": "./dist/helpers/jobs.d.ts",
+      "node": "./dist/helpers/jobs.js",
+      "browser": "./dist/helpers/jobs.mjs"
+    },
+    "./helpers/layouts": {
+      "types": "./dist/helpers/layouts.d.ts",
+      "node": "./dist/helpers/layouts.js",
+      "browser": "./dist/helpers/layouts.mjs"
+    },
+    "./helpers/permissions": {
+      "types": "./dist/helpers/permissions.d.ts",
+      "node": "./dist/helpers/permissions.js",
+      "browser": "./dist/helpers/permissions.mjs"
+    },
+    "./helpers/task-presets": {
+      "types": "./dist/helpers/task-presets.d.ts",
+      "node": "./dist/helpers/task-presets.js",
+      "browser": "./dist/helpers/task-presets.mjs"
+    },
+    "./helpers/tasks": {
+      "types": "./dist/helpers/tasks.d.ts",
+      "node": "./dist/helpers/tasks.js",
+      "browser": "./dist/helpers/tasks.mjs"
+    },
+    "./helpers/templates": {
+      "types": "./dist/helpers/templates.d.ts",
+      "node": "./dist/helpers/templates.js",
+      "browser": "./dist/helpers/templates.mjs"
     }
   },
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -32,30 +129,34 @@
     ]
   },
   "dependencies": {
-    "axios": "^1.6.4",
-    "date-fns": "^3.0.6"
+    "date-fns": "^4.1.0",
+    "nanoid": "^5.0.7",
+    "object-hash": "^3.0.0",
+    "ofetch": "^1.4.1"
   },
   "devDependencies": {
-    "@types/node": "^20.10.6",
+    "@types/node": "^22.7.3",
+    "@types/object-hash": "^3.0.6",
     "events": "^3.3.0",
-    "rimraf": "^5.0.5",
-    "typedoc": "^0.25.6",
-    "typescript": "^5.3.3",
-    "vite": "^5.0.10"
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "typedoc": "^0.27.1",
+    "typescript": "^5.7.2",
+    "vite": "^5.4.8"
   },
   "engines": {
-    "node": "^16 || ^18"
+    "node": "^20"
   },
   "scripts": {
     "prebuild": "rimraf --glob 'dist/*'",
-    "build": "run-s build:web build:node build:types build:docs",
-    "build:web": "tsc --project tsconfig.json && BUILD_TARGET=browser vite build",
-    "build:node": "tsc --project tsconfig.node.json && BUILD_TARGET=node vite build",
-    "build:types": "tsc --project tsconfig.types.json",
-    "build:docs": "typedoc src/index.ts",
-    "docs": "vite docs --open",
-    "dev": "run-p \"build:docs -- --watch\" docs",
-    "lint": "eslint --fix .",
-    "test": "npm run build && npm -w ezreeport-tests run test:sdk"
+    "build": "pnpm run /^build:.*/",
+    "build:docs": "typedoc",
+    "build:js": "vite build",
+    "build:types": "tsup",
+    "dev": "pnpm run --parallel \"/^(watch:docs)|(preview)$/\"",
+    "lint": "eslint .",
+    "preview": "vite docs --open",
+    "type-check": "tsc --noEmit --skipLibCheck",
+    "watch:docs": "typedoc --watch"
   }
 }