@ezpaarse-project/ezreeport-sdk-js 1.0.0-beta.1 → 1.0.0-beta.11

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

@@ -0,0 +1 @@
+{"version":3,"file":"tasksPresets.js","sourceRoot":"","sources":["../../../../src/modules/tasksPresets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAoC;AAGpC,yDAAuD;AAmBvD,MAAM,WAAW,GAAG,CAAC,MAAsB,EAAe,EAAE,CAAC,iCACxD,MAAM,KACT,SAAS,EAAE,IAAA,mBAAQ,EAAC,MAAM,CAAC,SAAS,CAAC,EACrC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,IACpE,CAAC;AAkBH,MAAM,eAAe,GAAG,CAAC,MAA0B,EAAmB,EAAE,CAAC,iCACpE,MAAM,KACT,SAAS,EAAE,IAAA,mBAAQ,EAAC,MAAM,CAAC,SAAS,CAAC,EACrC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,IACpE,CAAC;AAEH;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,GAA8C,EAAE;IAChF,MAAM,KAAoB,MAAM,eAAK,CAAC,IAAI,CAAmB,gBAAgB,CAAC,EAAxE,EAAE,OAAO,OAA+D,EAA1D,CAAC,cAAf,WAAiB,CAAuD,CAAC;IAC/E,uCACK,CAAC,KACJ,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IACjC;AACJ,CAAC,CAAA,CAAC;AANW,QAAA,kBAAkB,sBAM7B;AAEF;;;;;;;;GAQG;AACI,MAAM,cAAc,GAAG,CAC5B,UAA2C,EACJ,EAAE;IACzC,MAAM,EAAE,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;IACvE,MAAM,KAAoB,MAAM,eAAK,CAAC,IAAI,CAAqB,kBAAkB,EAAE,EAAE,CAAC,EAAhF,EAAE,OAAO,OAAuE,EAAlE,CAAC,cAAf,WAAiB,CAA+D,CAAC;IACvF,uCACK,CAAC,KACJ,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,IACjC;AACJ,CAAC,CAAA,CAAC;AATW,QAAA,cAAc,kBASzB;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAC/B,MAAwB,EACe,EAAE;IACzC,MAAM,KAAoB,MAAM,eAAK,CAAC,KAAK,CAAqB,iBAAiB,EAAE,MAAM,CAAC,EAApF,EAAE,OAAO,OAA2E,EAAtE,CAAC,cAAf,WAAiB,CAAmE,CAAC;IAC3F,uCACK,CAAC,KACJ,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,IACjC;AACJ,CAAC,CAAA,CAAC;AARW,QAAA,iBAAiB,qBAQ5B;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAC/B,MAAoD,EACb,EAAE;IACzC,MAAM,EAAE,EAAE,KAAW,MAAM,EAAZ,CAAC,UAAK,MAAM,EAArB,MAAY,CAAS,CAAC;IAC5B,MAAM,KAAoB,MAAM,eAAK,CAAC,IAAI,CACxC,kBAAkB,EAAE,EAAE,EACtB,CAAC,CACF,EAHK,EAAE,OAAO,OAGd,EAHmB,CAAC,cAAf,WAAiB,CAGtB,CAAC;IACF,uCACK,CAAC,KACJ,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,IACjC;AACJ,CAAC,CAAA,CAAC;AAZW,QAAA,iBAAiB,qBAY5B;AAEF;;;;;;;GAOG;AACI,MAAM,iBAAiB,GAAG,CAC/B,UAA2C,EAC5B,EAAE;IACjB,MAAM,EAAE,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;IACvE,MAAM,eAAK,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAA,CAAC;AALW,QAAA,iBAAiB,qBAK5B"}

package/dist/dist/dist/node/src/modules/tasksPresets.public.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteTasksPreset = exports.upsertTasksPreset = exports.createTasksPreset = exports.getTasksPreset = exports.getAllTasksPresets = void 0;
+var tasksPresets_1 = require("./tasksPresets");
+Object.defineProperty(exports, "getAllTasksPresets", { enumerable: true, get: function () { return tasksPresets_1.getAllTasksPresets; } });
+Object.defineProperty(exports, "getTasksPreset", { enumerable: true, get: function () { return tasksPresets_1.getTasksPreset; } });
+Object.defineProperty(exports, "createTasksPreset", { enumerable: true, get: function () { return tasksPresets_1.createTasksPreset; } });
+Object.defineProperty(exports, "upsertTasksPreset", { enumerable: true, get: function () { return tasksPresets_1.upsertTasksPreset; } });
+Object.defineProperty(exports, "deleteTasksPreset", { enumerable: true, get: function () { return tasksPresets_1.deleteTasksPreset; } });
+//# sourceMappingURL=tasksPresets.public.js.map

package/dist/dist/dist/node/src/modules/tasksPresets.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasksPresets.public.js","sourceRoot":"","sources":["../../../../src/modules/tasksPresets.public.ts"],"names":[],"mappings":";;;AAAA,+CASwB;AALtB,kHAAA,kBAAkB,OAAA;AAClB,8GAAA,cAAc,OAAA;AACd,iHAAA,iBAAiB,OAAA;AACjB,iHAAA,iBAAiB,OAAA;AACjB,iHAAA,iBAAiB,OAAA"}

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

@@ -0,0 +1,136 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+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 = 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
+ *
+ * @param template Raw template
+ *
+ * @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
+ *
+ * @param template Raw full template
+ *
+ * @returns Parsed template
+ */
+const parseFullTemplate = (template) => {
+    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
+ *
+ * Needs `general.templates-get` permission
+ *
+ * @returns All templates' info
+ */
+const getAllTemplates = () => __awaiter(void 0, void 0, void 0, function* () {
+    const _a = yield axios_1.default.$get('/templates'), { content } = _a, response = __rest(_a, ["content"]);
+    const r = response;
+    return Object.assign(Object.assign({}, r), { content: content.map(exports.parseTemplate) });
+});
+exports.getAllTemplates = getAllTemplates;
+/**
+ * Get template info
+ *
+ * Needs `general.templates-get-template` permission
+ *
+ * @param templateOrId Template or Template's id
+ *
+ * @returns Template info
+ */
+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;
+/**
+ * Create a new template
+ *
+ * Needs `general.templates-post` permission
+ *
+ * @param template Template's data
+ * @param namespaces
+ *
+ * @returns Created template's info
+ */
+const createTemplate = (template) => __awaiter(void 0, void 0, void 0, function* () {
+    const _c = yield axios_1.default.$post('/templates', template), { content } = _c, response = __rest(_c, ["content"]);
+    return Object.assign(Object.assign({}, response), { content: parseFullTemplate(content) });
+});
+exports.createTemplate = createTemplate;
+/**
+ * Update or create a template
+ *
+ * Needs `general.templates-put-template` permission
+ *
+ * @param template Template's data **with id**
+ * @param namespaces
+ *
+ * @returns Updated/Created Template's info
+ */
+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-template` permission
+ *
+ * @param id Template's id
+ * @param template New Template's data
+ * @param namespaces
+ *
+ * @deprecated use `upsertTemplate` instead
+ *
+ * @returns Updated Template's info
+ */
+exports.updateTemplate = exports.upsertTemplate;
+/**
+ * Delete a template
+ *
+ * Needs `general.templates-delete-template` permission
+ *
+ * @param templateOrId Template or Template's id
+ * @param namespaces
+ */
+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/dist/dist/node/src/modules/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../../src/modules/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAoC;AAEpC,yDAAuD;AAEvD,6CAAkE;AA2DlE;;;;;;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;AA6BH;;;;;;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/dist/dist/node/src/modules/templates.public.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteTemplate = exports.upsertTemplate = exports.updateTemplate = exports.createTemplate = exports.getTemplate = exports.getAllTemplates = void 0;
+var templates_1 = require("./templates");
+Object.defineProperty(exports, "getAllTemplates", { enumerable: true, get: function () { return templates_1.getAllTemplates; } });
+Object.defineProperty(exports, "getTemplate", { enumerable: true, get: function () { return templates_1.getTemplate; } });
+Object.defineProperty(exports, "createTemplate", { enumerable: true, get: function () { return templates_1.createTemplate; } });
+Object.defineProperty(exports, "updateTemplate", { enumerable: true, get: function () { return templates_1.updateTemplate; } });
+Object.defineProperty(exports, "upsertTemplate", { enumerable: true, get: function () { return templates_1.upsertTemplate; } });
+Object.defineProperty(exports, "deleteTemplate", { enumerable: true, get: function () { return templates_1.deleteTemplate; } });
+//# sourceMappingURL=templates.public.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"templates.public.js","sourceRoot":"","sources":["../../../../src/modules/templates.public.ts"],"names":[],"mappings":";;;AAAA,yCAYqB;AANnB,4GAAA,eAAe,OAAA;AACf,wGAAA,WAAW,OAAA;AACX,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA"}

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

@@ -1,24 +1,32 @@
 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 tasksActivity from './modules/tasksActivity.public';
+export * as tasksPresets from './modules/tasksPresets.public';
+/** @deprecated Use `tasksActivity` instead */
+export * as history 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';
 export * as setup from './modules/setup.public';
 export * as tasks from './modules/tasks.public';
 export * as templates from './modules/templates.public';
+export * as elastic from './modules/elastic.public';
 export { version } from '../package.json';
 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');
+    tasksPresets: typeof import('./modules/tasksPresets.public');
     templates: typeof import('./modules/templates.public');
+    elastic: typeof import('./modules/elastic.public');
     version: string;
 };

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

@@ -12,7 +12,7 @@ export interface ApiResponse<T> {
      */
     content: T;
 }
-export interface PaginatedApiResponse<T> extends ApiResponse<T> {
+export interface PaginatedApiResponse<T, K extends keyof T> extends ApiResponse<T[]> {
     meta: {
         /**
          * Count of items in response
@@ -29,7 +29,7 @@ export interface PaginatedApiResponse<T> extends ApiResponse<T> {
         /**
          * Id of last item in response
          */
-        lastId?: unknown;
+        lastId?: T[K];
     };
 }
 /**
@@ -40,7 +40,7 @@ export interface PaginatedApiResponse<T> extends ApiResponse<T> {
  *
  * @returns Response
  */
-export declare const axiosWithErrorFormatter: <T, Method extends "get" | "post" | "put" | "patch" | "delete">(method: Method, ...params: Parameters<Axios[Method]>) => Promise<AxiosResponse<T, any>>;
+export declare const axiosWithErrorFormatter: <T, Method extends "delete" | "get" | "post" | "put" | "patch">(method: Method, ...params: Parameters<Axios[Method]>) => Promise<AxiosResponse<T, any>>;
 declare const _default: import("axios").AxiosInstance & {
     $get: <T>(url: string, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T>>;
     $post: <T_1>(url: string, data?: unknown, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T_1>>;

package/dist/dist/dist/types/src/lib/promises.d.ts

@@ -0,0 +1,21 @@
+/// <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;
+    once: <P extends keyof E>(eventName: P, listener: (...args: E[P]) => void) => this;
+    off: <P extends keyof E>(eventName: P, listener: (...args: E[P]) => void) => this;
+}
+interface EventfulEmitter<E extends Record<string, any[]>> {
+    emit: <P extends keyof E>(eventName: P, ...args: E[P]) => this;
+}
+export type EventfulPromise<T, E extends Record<string, any[]>> = Promise<T> & EventfulListener<E>;
+/**
+ * Attach a `EventEmitter` to a `Promise` returned by the `executor`
+ *
+ * @param executor Executor returning the promise. The `emitter` is passed to the executor as param.
+ * @param emitter `EventEmitter` attached. By default it's a new instance.
+ *
+ * @returns The EventfulPromise
+ */
+declare const createEventfulPromise: <T, E extends Record<string, any[]> = Record<string, any[]>>(executor: (emitter: EventfulEmitter<E>) => Promise<T>, emitter?: EventEmitter) => EventfulPromise<T, E>;
+export default createEventfulPromise;

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

@@ -20,3 +20,8 @@ export interface Period extends Omit<RawPeriod, 'start' | 'end'> {
  * @returns Parsed period
  */
 export declare const parsePeriod: (period: RawPeriod) => Period;
+export type PaginationOpts = {
+    previous?: string;
+    count?: number;
+    sort?: string;
+};

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

@@ -1,5 +1,5 @@
 import { ApiResponse } from '../lib/axios';
-import { type Namespace, type RawNamespace } from './namespaces';
+import { type Namespace, type RawNamespace, type TaskCount } from './namespaces';
 export declare enum Access {
     READ = "READ",
     READ_WRITE = "READ_WRITE",
@@ -20,12 +20,12 @@ interface RawUser {
     username: string;
     token: string;
     isAdmin: true;
-    memberships: RawMembership[];
+    memberships: (RawMembership & TaskCount)[];
     createdAt: string;
     updatedAt?: string;
 }
 export interface User extends Omit<RawUser, 'memberships' | 'createdAt' | 'updatedAt'> {
-    memberships: Membership[];
+    memberships: (Membership & TaskCount)[];
     createdAt: Date;
     updatedAt?: Date;
 }
@@ -86,5 +86,5 @@ export declare const getCurrentPermissions: () => Promise<ApiResponse<Permission
  *
  * @returns Permissions
  */
-export declare const getCurrentNamespaces: () => Promise<ApiResponse<Namespace[]>>;
+export declare const getCurrentNamespaces: () => Promise<ApiResponse<(Namespace & TaskCount)[]>>;
 export {};

package/dist/{types → dist/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
  *
@@ -22,21 +24,23 @@ 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
+ *
+ * @deprecated Use `updateCron` with body `{ running: true }`
  *
  * @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 +52,31 @@ 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
+ *
+ * @deprecated Use `updateCron` with body `{ running: false }`
+ *
+ * @returns Cron's info
+ */
+export declare const stopCron: (cronOrName: Cron | Cron['name']) => Promise<{
+    content: Cron;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+/**
+ * Update cron
+ *
+ * Needs `general.crons-patch-cron` permission
+ *
+ * @param cronOrName Cron or Cron name
  *
  * @returns Cron's info
  */
-export declare const stopCron: (name: Cron['name']) => Promise<{
+export declare const updateCron: (cron: Partial<InputCron> & {
+    name: Cron['name'];
+}) => Promise<{
     content: Cron;
     status: {
         code: number;
@@ -64,11 +88,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/dist/dist/types/src/modules/crons.public.d.ts

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

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

@@ -0,0 +1,22 @@
+import type { Namespace } from './namespaces';
+/**
+ * List all available indices
+ *
+ * Needs `namespaces[namespaceId].elastic-get-indices` permission
+ *
+ * @param namespace The concerned namespace. **Needed if not admin**
+ *
+ * @returns The list of available indices
+ */
+export declare const getAllIndices: (namespace?: Namespace['id']) => Promise<import("../lib/axios").ApiResponse<string[]>>;
+/**
+ * Get mapping of an specific index
+ *
+ * Needs `namespaces[namespaceId].elastic-get-indices-index` permission
+ *
+ * @param index The index (can be a wildcard)
+ * @param namespace The concerned namespace. **Needed if not admin**
+ *
+ * @returns The list of available indices
+ */
+export declare const getIndexMapping: (index: string, namespace?: Namespace['id']) => Promise<import("../lib/axios").ApiResponse<Record<string, string>>>;

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

@@ -0,0 +1 @@
+export { getAllIndices, getIndexMapping, } from './elastic';

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

@@ -9,6 +9,16 @@ export interface Namespace extends Omit<RawNamespace, 'createdAt' | 'updatedAt'>
     createdAt: Date;
     updatedAt?: Date;
 }
+export interface TaskCount {
+    _count: {
+        tasks: number;
+    };
+}
+export interface MembersCount {
+    _count: {
+        memberships: number;
+    };
+}
 /**
  * Transform raw data from JSON, to JS usable data
  *

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

@@ -0,0 +1,120 @@
+import { type PaginatedApiResponse, type ApiResponse } from '../lib/axios';
+import type { PaginationOpts } from '../lib/utils';
+export interface Job<Data> {
+    id: number | string;
+    queue: string;
+    data: Data;
+}
+type JobStatus = 'completed' | 'waiting' | 'active' | 'delayed' | 'failed' | 'paused' | 'stuck';
+interface RawFullJob<Data, Result> {
+    id: Job<Data>['id'];
+    data: Job<Data>['data'];
+    result?: Result;
+    progress: number;
+    added: string;
+    started?: string;
+    ended?: string;
+    attempts: number;
+    status: JobStatus;
+}
+export interface FullJob<Data, Result> extends Omit<RawFullJob<Data, Result>, 'added' | 'started' | 'ended'> {
+    added: Date;
+    started?: Date;
+    ended?: Date;
+}
+export interface Queue {
+    status: 'paused' | 'active';
+    name: string;
+}
+export interface InputQueue {
+    status: Queue['status'];
+}
+/**
+ * Get all available queues
+ *
+ * Needs `general.queues-get` permission
+ *
+ * @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
+ *
+ * Needs `general.queues-put-queue-pause` permission
+ *
+ * @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>>;
+/**
+ * Resume queue
+ *
+ * Needs `general.queues-put-queue-resume` permission
+ *
+ * @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>>;
+/**
+ * Get queue info
+ *
+ * Needs `general.queues-get-queue-jobs` permission
+ *
+ * @param queueOrName Queue or queue's name
+ *
+ * @returns queue info
+ */
+export declare const getQueueJobs: <Data, Result>(queueOrName: Queue | Queue['name'], paginationOpts?: PaginationOpts) => Promise<PaginatedApiResponse<FullJob<Data, Result>, "id">>;
+/**
+ * Get job info
+ *
+ * Needs `namespaces[namespaceId].queues-get-queue-jobs-jobId` permission
+ *
+ * @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>(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 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>(queueOrName: Queue | Queue['name'], jobOrId: string | number | Job<Data>, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
+export {};

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

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