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

package/dist/node/src/modules/templates.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteTemplate = exports.updateTemplate = exports.upsertTemplate = exports.createTemplate = exports.getTemplate = exports.getAllTemplates = void 0;
+exports.deleteTemplate = exports.updateTemplate = exports.upsertTemplate = exports.createTemplate = exports.getTemplate = exports.getAllTemplates = exports.parseTemplate = void 0;
 const date_fns_1 = require("date-fns");
 const axios_1 = __importDefault(require("../lib/axios"));
+const tasks_base_1 = require("./tasks.base");
 /**
  * Transform raw data from JSON, to JS usable data
  *
@@ -34,6 +35,7 @@ const axios_1 = __importDefault(require("../lib/axios"));
  * @returns Parsed template
  */
 const parseTemplate = (template) => (Object.assign(Object.assign({}, template), { createdAt: (0, date_fns_1.parseISO)(template.createdAt), updatedAt: template.updatedAt ? (0, date_fns_1.parseISO)(template.updatedAt) : undefined }));
+exports.parseTemplate = parseTemplate;
 /**
  * Transform raw data from JSON, to JS usable data
  *
@@ -42,8 +44,8 @@ const parseTemplate = (template) => (Object.assign(Object.assign({}, template),
  * @returns Parsed template
  */
 const parseFullTemplate = (template) => {
-    const { body } = template, rawTemplate = __rest(template, ["body"]);
-    return Object.assign(Object.assign({}, parseTemplate(rawTemplate)), { body });
+    const { body, tasks } = template, rawTemplate = __rest(template, ["body", "tasks"]);
+    return Object.assign(Object.assign({}, (0, exports.parseTemplate)(rawTemplate)), { tasks: tasks.map(tasks_base_1.parseTask), body });
 };
 /**
  * Get all available templates
@@ -54,20 +56,22 @@ const parseFullTemplate = (template) => {
  */
 const getAllTemplates = () => __awaiter(void 0, void 0, void 0, function* () {
     const _a = yield axios_1.default.$get('/templates'), { content } = _a, response = __rest(_a, ["content"]);
-    return Object.assign(Object.assign({}, response), { content: content.map(parseTemplate) });
+    const r = response;
+    return Object.assign(Object.assign({}, r), { content: content.map(exports.parseTemplate) });
 });
 exports.getAllTemplates = getAllTemplates;
 /**
  * Get template info
  *
- * Needs `general.templates-get-name(*)` permission
+ * Needs `general.templates-get-template` permission
  *
- * @param name Template's name
+ * @param templateOrId Template or Template's id
  *
  * @returns Template info
  */
-const getTemplate = (name) => __awaiter(void 0, void 0, void 0, function* () {
-    const _b = yield axios_1.default.$get(`/templates/${name}`), { content } = _b, response = __rest(_b, ["content"]);
+const getTemplate = (templateOrId) => __awaiter(void 0, void 0, void 0, function* () {
+    const id = typeof templateOrId === 'string' ? templateOrId : templateOrId.id;
+    const _b = yield axios_1.default.$get(`/templates/${id}`), { content } = _b, response = __rest(_b, ["content"]);
     return Object.assign(Object.assign({}, response), { content: parseFullTemplate(content) });
 });
 exports.getTemplate = getTemplate;
@@ -79,8 +83,6 @@ exports.getTemplate = getTemplate;
  * @param template Template's data
  * @param namespaces
  *
- * @deprecated use `upsertTemplate` instead
- *
  * @returns Created template's info
  */
 const createTemplate = (template) => __awaiter(void 0, void 0, void 0, function* () {
@@ -91,23 +93,23 @@ exports.createTemplate = createTemplate;
 /**
  * Update or create a template
  *
- * Needs `general.templates-put-name(*)` permission
+ * Needs `general.templates-put-template` permission
  *
- * @param id Template's id
- * @param template Template's data
+ * @param template Template's data **with id**
  * @param namespaces
  *
  * @returns Updated/Created Template's info
  */
-const upsertTemplate = (name, template) => __awaiter(void 0, void 0, void 0, function* () {
-    const _d = yield axios_1.default.$put(`/templates/${name}`, template), { content } = _d, response = __rest(_d, ["content"]);
+const upsertTemplate = (template) => __awaiter(void 0, void 0, void 0, function* () {
+    const { id } = template, t = __rest(template, ["id"]);
+    const _d = yield axios_1.default.$put(`/templates/${id}`, t), { content } = _d, response = __rest(_d, ["content"]);
     return Object.assign(Object.assign({}, response), { content: parseFullTemplate(content) });
 });
 exports.upsertTemplate = upsertTemplate;
 /**
  * Update a template
  *
- * Needs `general.templates-put-name(*)` permission
+ * Needs `general.templates-put-template` permission
  *
  * @param id Template's id
  * @param template New Template's data
@@ -121,15 +123,14 @@ exports.updateTemplate = exports.upsertTemplate;
 /**
  * Delete a template
  *
- * Needs `general.templates-delete-name(*)` permission
+ * Needs `general.templates-delete-template` permission
  *
- * @param id Template's id
+ * @param templateOrId Template or Template's id
  * @param namespaces
- *
- * @returns Deleted Template's info
  */
-const deleteTemplate = (name) => __awaiter(void 0, void 0, void 0, function* () {
-    yield axios_1.default.$delete(`/templates/${name}`);
+const deleteTemplate = (templateOrId) => __awaiter(void 0, void 0, void 0, function* () {
+    const id = typeof templateOrId === 'string' ? templateOrId : templateOrId.id;
+    yield axios_1.default.$delete(`/templates/${id}`);
 });
 exports.deleteTemplate = deleteTemplate;
 //# sourceMappingURL=templates.js.map

package/dist/node/src/modules/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../../src/modules/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAoC;AACpC,yDAAuD;AAoCvD;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,CAAC,QAAqB,EAAY,EAAE,CAAC,iCACtD,QAAQ,KAEX,SAAS,EAAE,IAAA,mBAAQ,EAAC,QAAQ,CAAC,SAAS,CAAC,EACvC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,IACxE,CAAC;AAiBH;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,QAAyB,EAAgB,EAAE;IACpE,MAAM,EAAE,IAAI,KAAqB,QAAQ,EAAxB,WAAW,UAAK,QAAQ,EAAnC,QAAwB,CAAW,CAAC;IAE1C,uCACK,aAAa,CAAC,WAAW,CAAC,KAC7B,IAAI,IACJ;AACJ,CAAC,CAAC;AAOF;;;;;;GAMG;AACI,MAAM,eAAe,GAAG,GAA2C,EAAE;IAC1E,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAAgB,YAAY,CAAC,EAAxE,EAAE,OAAO,OAA+D,EAA1D,QAAQ,cAAtB,WAAwB,CAAgD,CAAC;IAE/E,uCACK,QAAQ,KACX,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAPW,QAAA,eAAe,mBAO1B;AAEF;;;;;;;;GAQG;AACI,MAAM,WAAW,GAAG,CAAO,IAAsB,EAAsC,EAAE;IAC9F,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAAkB,cAAc,IAAI,EAAE,CAAC,EAAlF,EAAE,OAAO,OAAyE,EAApE,QAAQ,cAAtB,WAAwB,CAA0D,CAAC;IAEzF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAPW,QAAA,WAAW,eAOtB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,cAAc,GAAG,CAC5B,QAAoD,EAChB,EAAE;IACtC,MAAM,KAA2B,MAAM,eAAK,CAAC,KAAK,CAChD,YAAY,EACZ,QAAQ,CACT,EAHK,EAAE,OAAO,OAGd,EAHmB,QAAQ,cAAtB,WAAwB,CAG7B,CAAC;IAEF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAZW,QAAA,cAAc,kBAYzB;AAEF;;;;;;;;;;GAUG;AACI,MAAM,cAAc,GAAG,CAC5B,IAAsB,EACtB,QAAuB,EACa,EAAE;IACtC,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAC/C,cAAc,IAAI,EAAE,EACpB,QAAQ,CACT,EAHK,EAAE,OAAO,OAGd,EAHmB,QAAQ,cAAtB,WAAwB,CAG7B,CAAC;IAEF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAbW,QAAA,cAAc,kBAazB;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,cAAc,GAAG,sBAAc,CAAC;AAE7C;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAG,CAAO,IAAsB,EAAiB,EAAE;IAC5E,MAAM,eAAK,CAAC,OAAO,CAAkB,cAAc,IAAI,EAAE,CAAC,CAAC;AAC7D,CAAC,CAAA,CAAC;AAFW,QAAA,cAAc,kBAEzB"}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../../src/modules/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAoC;AAEpC,yDAAuD;AAGvD,6CAAkE;AAoClE;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAC,QAAqB,EAAY,EAAE,CAAC,iCAC7D,QAAQ,KAEX,SAAS,EAAE,IAAA,mBAAQ,EAAC,QAAQ,CAAC,SAAS,CAAC,EACvC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,IACxE,CAAC;AALU,QAAA,aAAa,iBAKvB;AAmBH;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,QAAyB,EAAgB,EAAE;IACpE,MAAM,EAAE,IAAI,EAAE,KAAK,KAAqB,QAAQ,EAAxB,WAAW,UAAK,QAAQ,EAA1C,iBAA+B,CAAW,CAAC;IAEjD,uCACK,IAAA,qBAAa,EAAC,WAAW,CAAC,KAC7B,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,sBAAS,CAAC,EAC3B,IAAI,IACJ;AACJ,CAAC,CAAC;AAUF;;;;;;GAMG;AACI,MAAM,eAAe,GAAG,GAAwC,EAAE;IACvE,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAAgB,YAAY,CAAC,EAAxE,EAAE,OAAO,OAA+D,EAA1D,QAAQ,cAAtB,WAAwB,CAAgD,CAAC;IAC/E,MAAM,CAAC,GAAG,QAA2D,CAAC;IAEtE,uCACK,CAAC,KACJ,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAa,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AARW,QAAA,eAAe,mBAQ1B;AAEF;;;;;;;;GAQG;AACI,MAAM,WAAW,GAAG,CAAO,YAAuC,EAAsC,EAAE;IAC/G,MAAM,EAAE,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7E,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAAkB,cAAc,EAAE,EAAE,CAAC,EAAhF,EAAE,OAAO,OAAuE,EAAlE,QAAQ,cAAtB,WAAwB,CAAwD,CAAC;IAEvF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AARW,QAAA,WAAW,eAQtB;AAEF;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAG,CAC5B,QAAuB,EACa,EAAE;IACtC,MAAM,KAA2B,MAAM,eAAK,CAAC,KAAK,CAChD,YAAY,EACZ,QAAQ,CACT,EAHK,EAAE,OAAO,OAGd,EAHmB,QAAQ,cAAtB,WAAwB,CAG7B,CAAC;IAEF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAZW,QAAA,cAAc,kBAYzB;AAEF;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAG,CAC5B,QAAgD,EACZ,EAAE;IACtC,MAAM,EAAE,EAAE,KAAW,QAAQ,EAAd,CAAC,UAAK,QAAQ,EAAvB,MAAY,CAAW,CAAC;IAE9B,MAAM,KAA2B,MAAM,eAAK,CAAC,IAAI,CAC/C,cAAc,EAAE,EAAE,EAClB,CAAC,CACF,EAHK,EAAE,OAAO,OAGd,EAHmB,QAAQ,cAAtB,WAAwB,CAG7B,CAAC;IAEF,uCACK,QAAQ,KACX,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IACnC;AACJ,CAAC,CAAA,CAAC;AAdW,QAAA,cAAc,kBAczB;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,cAAc,GAAG,sBAAc,CAAC;AAE7C;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAO,YAAuC,EAAiB,EAAE;IAC7F,MAAM,EAAE,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7E,MAAM,eAAK,CAAC,OAAO,CAAkB,cAAc,EAAE,EAAE,CAAC,CAAC;AAC3D,CAAC,CAAA,CAAC;AAHW,QAAA,cAAc,kBAGzB"}

package/dist/types/{index.d.ts → src/index.d.ts}

@@ -1,7 +1,8 @@
 export * as auth from './modules/auth.public';
 export * as crons from './modules/crons.public';
 export * as health from './modules/health.public';
-export * as history from './modules/history.public';
+export * as history from './modules/tasksActivity.public';
+export * as tasksActivity from './modules/tasksActivity.public';
 export * as namespaces from './modules/namespaces.public';
 export * as queues from './modules/queues.public';
 export * as reports from './modules/reports.public';
@@ -13,12 +14,14 @@ export type EzReeportSDK = {
     auth: typeof import('./modules/auth.public');
     crons: typeof import('./modules/crons.public');
     health: typeof import('./modules/health.public');
-    history: typeof import('./modules/history.public');
+    /** @deprecated Use `tasksActivity` instead */
+    history: typeof import('./modules/tasksActivity.public');
     namespaces: typeof import('./modules/namespaces.public');
     queues: typeof import('./modules/queues.public');
     reports: typeof import('./modules/reports.public');
     setup: typeof import('./modules/setup.public');
     tasks: typeof import('./modules/tasks.public');
+    tasksActivity: typeof import('./modules/tasksActivity.public');
     templates: typeof import('./modules/templates.public');
     version: string;
 };

package/dist/types/{lib → src/lib}/promises.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import EventEmitter from 'events';
 interface EventfulListener<E extends Record<string, any[]>> {
     on: <P extends keyof E>(eventName: P, listener: (...args: E[P]) => void) => this;

package/dist/types/{modules → src/modules}/crons.d.ts

@@ -22,21 +22,21 @@ export declare const getAllCrons: () => Promise<ApiResponse<Cron[]>>;
  *
  * Needs `general.crons-get-cron` permission
  *
- * @param name Cron name
+ * @param cronOrName Cron or Cron name
  *
  * @returns Cron's info
  */
-export declare const getCron: (name: Cron['name']) => Promise<ApiResponse<Cron>>;
+export declare const getCron: (cronOrName: Cron | Cron['name']) => Promise<ApiResponse<Cron>>;
 /**
  * Start cron
  *
  * Needs `general.crons-put-cron-start` permission
  *
- * @param name Cron name
+ * @param cronOrName Cron or Cron name
  *
  * @returns Cron's info
  */
-export declare const startCron: (name: Cron['name']) => Promise<{
+export declare const startCron: (cronOrName: Cron | Cron['name']) => Promise<{
     content: Cron;
     status: {
         code: number;
@@ -48,11 +48,11 @@ export declare const startCron: (name: Cron['name']) => Promise<{
  *
  * Needs `general.crons-put-cron-stop` permission
  *
- * @param name Cron name
+ * @param cronOrName Cron or Cron name
  *
  * @returns Cron's info
  */
-export declare const stopCron: (name: Cron['name']) => Promise<{
+export declare const stopCron: (cronOrName: Cron | Cron['name']) => Promise<{
     content: Cron;
     status: {
         code: number;
@@ -64,11 +64,11 @@ export declare const stopCron: (name: Cron['name']) => Promise<{
  *
  * Needs `general.crons-post-cron-force` permission
  *
- * @param name Cron name
+ * @param cronOrName Cron or Cron name
  *
  * @returns Cron's info
  */
-export declare const forceCron: (name: Cron['name']) => Promise<{
+export declare const forceCron: (cronOrName: Cron | Cron['name']) => Promise<{
     content: Cron;
     status: {
         code: number;

package/dist/types/{modules → src/modules}/queues.d.ts

@@ -38,31 +38,31 @@ export declare const getAllQueues: () => Promise<ApiResponse<Queue[]>>;
  *
  * Needs `general.queues-put-queue-pause` permission
  *
- * @param queueName Name of the queue
+ * @param queueOrName Queue or queue's name
  *
  * @returns queue info
  */
-export declare const pauseQueue: (queueName: string) => Promise<ApiResponse<Queue>>;
+export declare const pauseQueue: (queueOrName: Queue | Queue['name']) => Promise<ApiResponse<Queue>>;
 /**
  * Resume queue
  *
  * Needs `general.queues-put-queue-resume` permission
  *
- * @param queueName Name of the queue
+ * @param queueOrName Queue or queue's name
  *
  * @returns queue info
  */
-export declare const resumeQueue: (queueName: string) => Promise<ApiResponse<Queue>>;
+export declare const resumeQueue: (queueOrName: Queue | Queue['name']) => Promise<ApiResponse<Queue>>;
 /**
  * Get queue info
  *
  * Needs `general.queues-get-queue-jobs` permission
  *
- * @param queueName Name of the queue
+ * @param queueOrName Queue or queue's name
  *
  * @returns queue info
  */
-export declare const getQueueJobs: <Data, Result>(queueName: string, paginationOpts?: {
+export declare const getQueueJobs: <Data, Result>(queueOrName: Queue | Queue['name'], paginationOpts?: {
     previous?: string | number | undefined;
     count?: number | undefined;
 } | undefined) => Promise<PaginatedApiResponse<FullJob<Data, Result>[]>>;
@@ -71,23 +71,23 @@ export declare const getQueueJobs: <Data, Result>(queueName: string, paginationO
  *
  * Needs `namespaces[namespaceId].queues-get-queue-jobs-jobId` permission
  *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
+ * @param queueOrName Queue or queue's name where job is
+ * @param jobOrId Job or job's id in queue
  * @param namespaces
  *
  * @returns Job full info
  */
-export declare const getJob: <Data, Result>(queueName: string, jobId: string | number, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
+export declare const getJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: string | number | Job<Data>, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
 /**
  * Retry job that failed
  *
  * Needs `namespaces[namespaceId].queues-post-queue-jobs-jobId-retry` permission
  *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
+ * @param queueOrName Queue or queue's name where job is
+ * @param jobOrId Job or job's id in queue
  * @param namespaces
  *
  * @returns queue info
  */
-export declare const retryJob: <Data, Result>(queueName: string, jobId: string | number, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
+export declare const retryJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: string | number | Job<Data>, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
 export {};

package/dist/types/{modules → src/modules}/reports.d.ts

@@ -1,6 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import { Stream } from 'stream';
 import { type Period, type RawPeriod } from '../lib/utils';
-import { getJob, type FullJob, type Job } from './queues';
+import { type FullJob, type Job, type Queue } from './queues';
 import type { RawFullTask } from './tasks';
 interface RawReportResultDetail {
     createdAt: string;
@@ -19,6 +21,11 @@ interface RawReportResultDetail {
     error?: {
         message: string;
         stack: string[];
+        cause?: {
+            type: string;
+            layout: number;
+            figure?: number;
+        };
     };
     meta?: unknown;
 }
@@ -48,13 +55,13 @@ type FullReportJob = FullJob<RawReportData, RawReportResult>;
  *
  * Needs `namespaces[namespaceId].tasks-post-task-run` permission
  *
- * @param taskId Id of the task
+ * @param taskOrId Id of the task
  * @param params Other params for overriding default
  * @param namespaces
  *
  * @returns Job info to track progress
  */
-export declare const startGeneration: (taskId: RawFullTask['id'], params?: {
+export declare const startGeneration: (taskOrId: RawFullTask | RawFullTask['id'], params?: {
     /**
      * Override targets of task. Also enable first level of debugging
      * (disable generation history)
@@ -95,7 +102,7 @@ type GenerationEvents = {
  *
  * @returns When generation ends, with detail
  */
-export declare const startAndListenGeneration: (taskId: string, params?: {
+export declare const startAndListenGeneration: (taskOrId: string | RawFullTask, params?: {
     /**
      * Override targets of task. Also enable first level of debugging
      * (disable generation history)
@@ -113,7 +120,6 @@ interface ResponseTypeMap {
     text: string;
     stream: Stream;
 }
-type GetJobParams = Parameters<typeof getJob>;
 /**
  * Get report main file (the result) by giving the report's name
  *
@@ -133,14 +139,14 @@ export declare const getReportFileByName: <Result extends keyof ResponseTypeMap
  * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
  * & `namespaces[namespaceId].queues-get-queue-jobs-jobId ` permission
  *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
+ * @param queueOrName Queue or queue's name where job is
+ * @param jobOrId Job or job's id in queue
  * @param namespaces
  * @param responseType Wanted response type
  *
  * @returns The report's content
  */
-export declare const getReportFileByJob: <Result extends keyof ResponseTypeMap = "text">(queueName: GetJobParams[0], jobId: GetJobParams[1], namespaces?: GetJobParams[2], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportFileByJob: <Result extends keyof ResponseTypeMap = "text">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
 /**
  * Get report detail by giving the report's name
  *
@@ -160,15 +166,15 @@ export declare const getReportDetailByName: (name: string, namespaces?: string[]
  * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
  * & `namespaces[namespaceId].queues-get-queue-jobs-jobId` permission
  *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
+ * @param queueOrName Queue or queue's name where job is
+ * @param jobOrId Job or job's id in queue
  * @param namespaces
  * @param responseType Wanted response type. **If provided with anything but `json` you will have to
  * cast in your type to avoid auto-completion issues.**
  *
  * @returns The detail's content
  */
-export declare const getReportDetailByJob: (queueName: GetJobParams[0], jobId: GetJobParams[1], namespaces?: GetJobParams[2], responseType?: keyof ResponseTypeMap) => Promise<ReportResult>;
+export declare const getReportDetailByJob: (queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: keyof ResponseTypeMap) => Promise<ReportResult>;
 /**
  * Get report debug file by giving the report's name
  *
@@ -187,12 +193,12 @@ export declare const getReportDebugByName: <Result extends keyof ResponseTypeMap
  * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
  * & `namespaces[namespaceId].queues-get-queue-jobs-jobId ` permission
  *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
+ * @param queueOrName Queue or queue's name where job is
+ * @param jobOrId Job or job's id in queue
  * @param namespaces
  * @param responseType Wanted response type
  *
  * @returns The debug's content
  */
-export declare const getReportDebugByJob: <Result extends keyof ResponseTypeMap = "json">(queueName: GetJobParams[0], jobId: GetJobParams[1], namespaces?: GetJobParams[2], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportDebugByJob: <Result extends keyof ResponseTypeMap = "json">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
 export {};

package/dist/types/{modules → src/modules}/tasks.d.ts

@@ -1,22 +1,32 @@
 import { type ApiResponse, type PaginatedApiResponse } from '../lib/axios';
 import type { JsonObject } from '../lib/utils';
-import { type History, type RawHistory } from './history';
+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';
-import type { Layout } from './templates';
 interface AdditionalRawTaskData {
     template: {
-        extends: string;
         fetchOptions?: JsonObject;
         inserts?: (Layout & {
             at: number;
         })[];
     };
+    extends: RawTemplate;
+    lastExtended?: {
+        id: string;
+        tags: RawTemplate['tags'];
+    };
     targets: string[];
-    history: RawHistory[];
+    activity: RawActivity[];
 }
-interface AdditionalTaskData extends Omit<AdditionalRawTaskData, 'history'> {
-    history: History[];
+interface AdditionalTaskData extends Omit<AdditionalRawTaskData, 'activity' | 'extends' | 'lastExtended'> {
+    activity: Activity[];
+    extends: Template;
+    lastExtended?: {
+        id: Template['id'];
+        name: Template['name'];
+        tags: Template['tags'];
+    };
 }
 export interface RawFullTask extends RawTaskWithNamespace, AdditionalRawTaskData {
 }
@@ -26,7 +36,11 @@ export interface InputTask extends Pick<FullTask, 'name' | 'template' | 'targets
     namespace?: Task['namespaceId'];
     nextRun?: FullTask['nextRun'];
     enabled?: FullTask['enabled'];
+    extends: string;
 }
+export type TaskList = (Task & {
+    tags: Template['tags'];
+})[];
 /**
  * Get all available tasks
  *
@@ -40,7 +54,7 @@ export interface InputTask extends Pick<FullTask, 'name' | 'template' | 'targets
 export declare const getAllTasks: (paginationOpts?: {
     previous?: Task['id'];
     count?: number;
-}, namespaces?: Namespace['id'][]) => Promise<PaginatedApiResponse<Task[]>>;
+}, namespaces?: Namespace['id'][]) => Promise<PaginatedApiResponse<TaskList>>;
 /**
  * Create a new task
  *
@@ -57,69 +71,97 @@ export declare const createTask: (task: InputTask, namespaces?: Namespace['id'][
  *
  * Needs `namespaces[namespaceId].tasks-get-task` permission
  *
- * @param id Task's id
+ * @param taskOrId Task or Task's id
  * @param namespaces
  *
  * @returns Task's info
  */
-export declare const getTask: (id: Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export declare const getTask: (taskOrId: Task | Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
 /**
  * Update or create a task
  *
  * Needs `namespaces[namespaceId].tasks-put-task` permission
  *
- * @param id Task's id
- * @param task Task's data
+ * @param task Task's data **with id**
  * @param namespaces
  *
  * @returns Updated/Created Task's info
  */
-export declare const upsertTask: (id: Task['id'], task: InputTask, namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export declare const upsertTask: (task: InputTask & {
+    id: Task['id'];
+}, namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
 /**
  * Update a task
  *
  * Needs `namespaces[namespaceId].tasks-put-task` permission
  *
- * @param id Task's id
- * @param task New Task's data
+ * @param task Task's data **with id**
  * @param namespaces
  *
  * @deprecated Use `upsertTask` instead
  *
  * @returns Updated Task's info
  */
-export declare const updateTask: (id: Task['id'], task: InputTask, namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export declare const updateTask: (task: InputTask & {
+    id: Task['id'];
+}, namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
 /**
  * Delete a task
  *
  * Needs `namespaces[namespaceId].tasks-delete-task` permission
  *
- * @param id Task's id
+ * @param taskOrId Task or Task's id
  * @param namespaces
- *
- * @returns Deleted Task's info
  */
-export declare const deleteTask: (id: Task['id'], namespaces?: Namespace['id'][]) => Promise<void>;
+export declare const deleteTask: (taskOrId: Task | Task['id'], namespaces?: Namespace['id'][]) => Promise<void>;
 /**
  * Shorthand to enable task
  *
  * Needs `namespaces[namespaceId].tasks-put-task-enable` permission
  *
- * @param id Task's id
+ * @param taskOrId Task or Task's id
  * @param namespaces
  *
  * @returns Updated task's info
  */
-export declare const enableTask: (id: Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export declare const enableTask: (taskOrId: Task | Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
 /**
  * Shorthand to disable task
  *
  * Needs `namespaces[namespaceId].tasks-put-task-disable` permission
  *
- * @param id Task's id
+ * @param taskOrId Task or Task's id
  * @param namespaces
  *
  * @returns Updated task's info
  */
-export declare const disableTask: (id: Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export declare const disableTask: (taskOrId: Task | Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+/**
+ * Link a task to a template
+ *
+ * Needs `namespaces[namespaceId].tasks-put-task-link-template` permission
+ *
+ * @param taskOrId Task or Task's id
+ * @param templateOrId Template or Template's id
+ * @param namespaces
+ *
+ * @returns Updated task's info
+ */
+export declare const linkTaskToTemplate: (taskOrId: Task | Task['id'], templateOrId: Template | Template['id'], namespaces?: Namespace['id'][]) => Promise<{
+    content: FullTask;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+/**
+ * Unlink a task to a template
+ *
+ * Needs `namespaces[namespaceId].tasks-delete-task-link-template` permission
+ *
+ * @param taskOrId Task or Task's id
+ * @param templateOrId Template or Template's id
+ * @param namespaces
+ */
+export declare const unlinkTaskToTemplate: (taskOrId: Task | Task['id'], templateOrId: Template | Template['id'], namespaces?: Namespace['id'][]) => Promise<void>;
 export {};

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

@@ -0,0 +1,2 @@
+export { type FullTask, type InputTask, type TaskList, getAllTasks, 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/tasksActivity.d.ts

@@ -0,0 +1,38 @@
+import { type PaginatedApiResponse } from '../lib/axios';
+import { type TaskWithNamespace } from './tasks.base';
+export interface RawActivity {
+    id: string;
+    taskId: string;
+    type: string;
+    message: string;
+    data?: object;
+    createdAt: string;
+}
+export interface Activity extends Omit<RawActivity, 'createdAt'> {
+    createdAt: Date;
+}
+export interface ActivityWithTask extends Omit<Activity, 'taskId'> {
+    task: TaskWithNamespace;
+}
+/**
+ * Transform raw data from JSON, to JS usable data
+ *
+ * @param entry Raw history entry
+ *
+ * @returns Parsed history entry
+ */
+export declare const parseActivity: (entry: RawActivity) => Activity;
+/**
+ * Get all available history entries
+ *
+ * Needs `namespaces[namespaceId].history-get` permission
+ *
+ * @param paginationOpts Options for pagination
+ * @param namespaces
+ *
+ * @returns All history entries' info
+ */
+export declare const getAllEntries: (paginationOpts?: {
+    previous?: Activity['id'];
+    count?: number;
+}, namespaces?: string[]) => Promise<PaginatedApiResponse<ActivityWithTask[]>>;

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

@@ -0,0 +1,5 @@
+export { 
+/** @deprecated Use `Activity` instead */
+type Activity as History, 
+/** @deprecated Use `ActivityWithTask` instead */
+type ActivityWithTask as HistoryWithTask, type Activity, type ActivityWithTask, getAllEntries, } from './tasksActivity';