@ezpaarse-project/ezreeport-sdk-js 1.0.0-beta.6 → 1.0.0-beta.8

package/dist/types/src/modules/crons.d.ts

@@ -9,6 +9,8 @@ export interface Cron extends Omit<RawCron, 'nextRun' | 'lastRun'> {
     nextRun?: Date;
     lastRun?: Date;
 }
+export interface InputCron extends Pick<Cron, 'running'> {
+}
 /**
  * Get all available crons
  *
@@ -34,6 +36,8 @@ export declare const getCron: (cronOrName: Cron | Cron['name']) => Promise<ApiRe
  *
  * @param cronOrName Cron or Cron name
  *
+ * @deprecated Use `updateCron` with body `{ running: true }`
+ *
  * @returns Cron's info
  */
 export declare const startCron: (cronOrName: Cron | Cron['name']) => Promise<{
@@ -50,6 +54,8 @@ export declare const startCron: (cronOrName: Cron | Cron['name']) => Promise<{
  *
  * @param cronOrName Cron or Cron name
  *
+ * @deprecated Use `updateCron` with body `{ running: false }`
+ *
  * @returns Cron's info
  */
 export declare const stopCron: (cronOrName: Cron | Cron['name']) => Promise<{
@@ -59,6 +65,24 @@ export declare const stopCron: (cronOrName: Cron | Cron['name']) => Promise<{
         message: string;
     };
 }>;
+/**
+ * Update cron
+ *
+ * Needs `general.crons-patch-cron` permission
+ *
+ * @param cronOrName Cron or Cron name
+ *
+ * @returns Cron's info
+ */
+export declare const updateCron: (cron: Partial<InputCron> & {
+    name: Cron['name'];
+}) => Promise<{
+    content: Cron;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
 /**
  * Force cron to run
  *

package/dist/types/src/modules/crons.public.d.ts

@@ -1 +1 @@
-export { type Cron, getAllCrons, getCron, startCron, stopCron, forceCron, } from './crons';
+export { type Cron, type InputCron, getAllCrons, getCron, startCron, stopCron, updateCron, forceCron, } from './crons';

package/dist/types/src/modules/queues.d.ts

@@ -25,6 +25,9 @@ export interface Queue {
     status: 'paused' | 'active';
     name: string;
 }
+export interface InputQueue {
+    status: Queue['status'];
+}
 /**
  * Get all available queues
  *
@@ -33,6 +36,28 @@ export interface Queue {
  * @returns All queues' names
  */
 export declare const getAllQueues: () => Promise<ApiResponse<Queue[]>>;
+/**
+ * Get specific queue
+ *
+ * Needs `general.queues-get-queue` permission
+ *
+ * @param queueOrName Queue or queue's name
+ *
+ * @returns queue info
+ */
+export declare const getQueue: (queueOrName: Queue | Queue['name']) => Promise<ApiResponse<Queue>>;
+/**
+ * Update specific queue
+ *
+ * Needs `general.queues-patch-queue` permission
+ *
+ * @param queueOrName Queue or queue's name
+ *
+ * @returns queue info
+ */
+export declare const updateQueue: (queue: Partial<InputQueue> & {
+    name: Queue['name'];
+}) => Promise<ApiResponse<Queue>>;
 /**
  * Pause queue
  *
@@ -40,6 +65,8 @@ export declare const getAllQueues: () => Promise<ApiResponse<Queue[]>>;
  *
  * @param queueOrName Queue or queue's name
  *
+ * @deprecated Use `updateQueue` instead
+ *
  * @returns queue info
  */
 export declare const pauseQueue: (queueOrName: Queue | Queue['name']) => Promise<ApiResponse<Queue>>;
@@ -50,6 +77,8 @@ export declare const pauseQueue: (queueOrName: Queue | Queue['name']) => Promise
  *
  * @param queueOrName Queue or queue's name
  *
+ * @deprecated Use `updateQueue` instead
+ *
  * @returns queue info
  */
 export declare const resumeQueue: (queueOrName: Queue | Queue['name']) => Promise<ApiResponse<Queue>>;

package/dist/types/src/modules/queues.public.d.ts

@@ -1 +1 @@
-export { type Job, type FullJob, type Queue, getAllQueues, pauseQueue, resumeQueue, getQueueJobs, getJob, retryJob, } from './queues';
+export { type Job, type FullJob, type Queue, type InputQueue, getAllQueues, getQueue, updateQueue, pauseQueue, resumeQueue, getQueueJobs, getJob, retryJob, } from './queues';

package/dist/types/src/modules/reports.d.ts

@@ -53,9 +53,9 @@ type FullReportJob = FullJob<RawReportData, RawReportResult>;
 /**
  * Start generation of a report
  *
- * Needs `namespaces[namespaceId].tasks-post-task-run` permission
+ * Needs `namespaces[namespaceId].tasks-post-task-_run` permission
  *
- * @param taskOrId Id of the task
+ * @param taskOrId Task or id of the task
  * @param params Other params for overriding default
  * @param namespaces
  *
@@ -90,7 +90,7 @@ type GenerationEvents = {
  * Needs `namespaces[namespaceId].tasks-post-task-run`
  * & `namespaces[namespaceId].queues-get-queue-jobs-jobId` permissions
  *
- * @param taskId Id of the task
+ * @param taskOrId Task or id of the task
  * @param params Other params for overriding default
  * @param namespaces
  *

package/dist/types/src/modules/tasks.d.ts

@@ -1,12 +1,15 @@
 import { type ApiResponse, type PaginatedApiResponse } from '../lib/axios';
-import type { JsonObject } from '../lib/utils';
 import { type Activity, type RawActivity } from './tasksActivity';
 import type { Namespace } from './namespaces';
 import { type Layout, type RawTemplate, type Template } from './templates';
 import { type Task, type RawTaskWithNamespace, type TaskWithNamespace } from './tasks.base';
 interface AdditionalRawTaskData {
     template: {
-        fetchOptions?: JsonObject;
+        fetchOptions?: {
+            filters?: Record<string, any>;
+            dateField?: string;
+            index: string;
+        };
         inserts?: (Layout & {
             at: number;
         })[];
@@ -55,6 +58,57 @@ export declare const getAllTasks: (paginationOpts?: {
     previous?: Task['id'];
     count?: number;
 }, namespaces?: Namespace['id'][]) => Promise<PaginatedApiResponse<TaskList>>;
+/**
+ * Get targets of available tasks
+ *
+ * Needs `namespaces[namespaceId].tasks-get-_targets` permission
+ *
+ * @param namespaces
+ *
+ * @returns Targets' email
+ */
+export declare const getAllTargets: (namespaces?: Namespace['id'][]) => Promise<ApiResponse<string[]>>;
+/**
+ * Get available tasks of specific target
+ *
+ * Needs `namespaces[namespaceId].tasks-get-_targets-email-tasks` permission
+ *
+ * @param email The email of the target
+ * @param namespaces
+ *
+ * @returns Tasks where given email is a target
+ */
+export declare const getTasksOfTarget: (email: string, namespaces?: Namespace['id'][]) => Promise<{
+    content: {
+        nextRun: Date;
+        lastRun?: Date | undefined;
+        createdAt: Date;
+        updatedAt?: Date | undefined;
+        name: string;
+        id: string;
+        namespaceId: string;
+        recurrence: import("./tasks.base").Recurrence;
+        enabled: boolean;
+        tags: {
+            name: string;
+            color?: string | undefined;
+        }[];
+    }[];
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+/**
+ * Unsubscribe a target from a task
+ *
+ * Needs `namespaces[namespaceId].tasks-get-_targets-email-tasks` permission
+ *
+ * @param email The email of the target
+ * @param taskOrId Task or Task's id
+ * @param namespaces
+ */
+export declare const unsubTargetOfTask: (email: string, taskOrId: Task | Task['id'], namespaces?: Namespace['id'][]) => Promise<void>;
 /**
  * Create a new task
  *
@@ -117,7 +171,7 @@ export declare const deleteTask: (taskOrId: Task | Task['id'], namespaces?: Name
 /**
  * Shorthand to enable task
  *
- * Needs `namespaces[namespaceId].tasks-put-task-enable` permission
+ * Needs `namespaces[namespaceId].tasks-put-_task-enable` permission
  *
  * @param taskOrId Task or Task's id
  * @param namespaces
@@ -128,7 +182,7 @@ export declare const enableTask: (taskOrId: Task | Task['id'], namespaces?: Name
 /**
  * Shorthand to disable task
  *
- * Needs `namespaces[namespaceId].tasks-put-task-disable` permission
+ * Needs `namespaces[namespaceId].tasks-put-_task-disable` permission
  *
  * @param taskOrId Task or Task's id
  * @param namespaces
@@ -139,7 +193,7 @@ export declare const disableTask: (taskOrId: Task | Task['id'], namespaces?: Nam
 /**
  * Link a task to a template
  *
- * Needs `namespaces[namespaceId].tasks-put-task-link-template` permission
+ * Needs `namespaces[namespaceId].tasks-put-task-_link-template` permission
  *
  * @param taskOrId Task or Task's id
  * @param templateOrId Template or Template's id
@@ -157,7 +211,7 @@ export declare const linkTaskToTemplate: (taskOrId: Task | Task['id'], templateO
 /**
  * Unlink a task to a template
  *
- * Needs `namespaces[namespaceId].tasks-delete-task-link-template` permission
+ * Needs `namespaces[namespaceId].tasks-delete-task-_link-template` permission
  *
  * @param taskOrId Task or Task's id
  * @param templateOrId Template or Template's id

package/dist/types/src/modules/tasks.public.d.ts

@@ -1,2 +1,2 @@
-export { type FullTask, type InputTask, type TaskList, getAllTasks, getTask, createTask, updateTask, upsertTask, deleteTask, enableTask, disableTask, linkTaskToTemplate, unlinkTaskToTemplate, } from './tasks';
+export { type FullTask, type InputTask, type TaskList, getAllTasks, getAllTargets, getTasksOfTarget, unsubTargetOfTask, getTask, createTask, updateTask, upsertTask, deleteTask, enableTask, disableTask, linkTaskToTemplate, unlinkTaskToTemplate, } from './tasks';
 export { Recurrence, type Task, type TaskWithNamespace, } from './tasks.base';

package/dist/types/src/modules/templates.d.ts

@@ -1,22 +1,35 @@
 import { type ApiResponse } from '../lib/axios';
-import type { JsonObject } from '../lib/utils';
 import { type RawTask, type Task } from './tasks.base';
+interface FigureFetchOptions {
+    fetchCount?: string;
+    filters?: Record<string, any>;
+}
+interface FigureFetchOptionsAggs extends FigureFetchOptions {
+    aggs?: Record<string, any>[];
+}
+interface FigureFetchOptionsBuckets extends FigureFetchOptions {
+    buckets?: Record<string, any>[];
+    metric?: Record<string, any>;
+}
 export interface Figure {
     type: string;
     data?: string | unknown[];
-    params: JsonObject;
+    params: Record<string, any>;
+    fetchOptions?: FigureFetchOptionsAggs | FigureFetchOptionsBuckets;
     slots?: number[];
 }
 export interface Layout {
     data?: unknown;
     fetcher?: string;
-    fetchOptions?: JsonObject;
+    fetchOptions?: {
+        fetchCount?: string;
+        filters?: Record<string, any>;
+    };
     figures: Figure[];
 }
 export interface RawTemplate {
     id: string;
     name: string;
-    renderer: string;
     pageCount: number;
     tags: {
         name: string;
@@ -40,8 +53,16 @@ export declare const parseTemplate: (template: RawTemplate) => Template;
 export interface RawFullTemplate extends RawTemplate {
     body: {
         renderer?: string;
-        renderOptions?: JsonObject;
-        fetchOptions?: JsonObject;
+        renderOptions?: {
+            grid?: {
+                cols: number;
+                rows: number;
+            };
+        };
+        fetchOptions?: {
+            filters?: Record<string, any>;
+            dateField: string;
+        };
         layouts: Layout[];
     };
     tasks: RawTask[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ezpaarse-project/ezreeport-sdk-js",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.8",
   "description": "JS SDK to communicate with ezReeport API",
   "homepage": "https://github.com/ezpaarse-project/ezreeport#readme",
   "bugs": {
@@ -26,7 +26,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "run-s build:web build:node build:doc",
+    "build": "run-s build:web build:node build:docs",
     "build:node-vite": "tsc && BUILD_TARGET=node vite build",
     "build:node": "tsc --project tsconfig.node.json",
     "build:web": "tsc && BUILD_TARGET=browser vite build",
@@ -42,15 +42,15 @@
     ]
   },
   "dependencies": {
-    "axios": "^1.4.0",
+    "axios": "^1.5.0",
     "date-fns": "^2.30.0",
     "events": "^3.3.0"
   },
   "devDependencies": {
-    "@types/node": "^20.4.5",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.6",
-    "vite": "^4.4.7"
+    "@types/node": "^20.6.0",
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.9"
   },
   "engines": {
     "node": "^16 || ^18"