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

package/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/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/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/src/index.d.ts

@@ -0,0 +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 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');
+    /** @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/src/lib/axios.d.ts

@@ -0,0 +1,51 @@
+import { Axios, AxiosResponse } from 'axios';
+export interface ApiResponse<T> {
+    /**
+     * HTTP Status
+     */
+    status: {
+        code: number;
+        message: string;
+    };
+    /**
+     * Content of the response
+     */
+    content: T;
+}
+export interface PaginatedApiResponse<T, K extends keyof T> extends ApiResponse<T[]> {
+    meta: {
+        /**
+         * Count of items in response
+         */
+        count: number;
+        /**
+         * Count of items wanted
+         */
+        size: number;
+        /**
+         * Count of items available
+         */
+        total: number;
+        /**
+         * Id of last item in response
+         */
+        lastId?: T[K];
+    };
+}
+/**
+ * Start axios request with basic error handling
+ *
+ * @param method The request's method
+ * @param params The other params of axios
+ *
+ * @returns Response
+ */
+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>>;
+    $put: <T_2>(url: string, data?: unknown, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T_2>>;
+    $patch: <T_3>(url: string, data?: unknown, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T_3>>;
+    $delete: <T_4>(url: string, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T_4>>;
+};
+export default _default;

package/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/src/lib/utils.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Async version of `setTimeout`
+ *
+ * @param ms Time to wait
+ */
+export declare const setTimeoutAsync: (ms: number) => Promise<unknown>;
+export interface RawPeriod {
+    start: string;
+    end: string;
+}
+export interface Period extends Omit<RawPeriod, 'start' | 'end'> {
+    start: Date;
+    end: Date;
+}
+/**
+ * Transform raw data from JSON, to JS usable data
+ *
+ * @param period Raw period
+ *
+ * @returns Parsed period
+ */
+export declare const parsePeriod: (period: RawPeriod) => Period;
+export type PaginationOpts = {
+    previous?: string;
+    count?: number;
+    sort?: string;
+};

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

@@ -0,0 +1,90 @@
+import { ApiResponse } from '../lib/axios';
+import { type Namespace, type RawNamespace, type TaskCount } from './namespaces';
+export declare enum Access {
+    READ = "READ",
+    READ_WRITE = "READ_WRITE",
+    SUPER_USER = "SUPER_USER"
+}
+interface RawMembership {
+    access: Access;
+    namespace: RawNamespace;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface Membership extends Omit<RawMembership, 'namespace' | 'createdAt' | 'updatedAt'> {
+    namespace: Namespace;
+    createdAt: Date;
+    updatedAt?: Date;
+}
+interface RawUser {
+    username: string;
+    token: string;
+    isAdmin: true;
+    memberships: (RawMembership & TaskCount)[];
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface User extends Omit<RawUser, 'memberships' | 'createdAt' | 'updatedAt'> {
+    memberships: (Membership & TaskCount)[];
+    createdAt: Date;
+    updatedAt?: Date;
+}
+export type Permissions = {
+    /**
+     * General routes independent of namespaces
+     */
+    general: {
+        [routeId: string]: boolean;
+    };
+    /**
+     * Routes who are dependent of namespaces
+     *
+     * If wanted namespace isn't present, then user doesn't have access
+     */
+    namespaces: {
+        [namespaceId: string]: {
+            [routeId: string]: boolean;
+        };
+    };
+};
+/**
+ * Set auth token to axios
+ *
+ * @param token The auth token
+ */
+export declare const login: (token: string) => void;
+/**
+ * Unset auth token from axios
+ */
+export declare const logout: () => void;
+/**
+ * Check if auth token is setup in axios. **DOESN'T CHECK IF TOKEN IS VALID !**
+ *
+ * @returns If auth token is setup
+ */
+export declare const isLogged: () => boolean;
+/**
+ * Get logged user info
+ *
+ * Needs `general.auth-get` permission
+ *
+ * @returns The logged user info
+ */
+export declare const getCurrentUser: () => Promise<ApiResponse<User>>;
+/**
+ * Get logged user permissions
+ *
+ * Needs `namespaces[namespaceId].auth-get-permissions` permission
+ *
+ * @returns Permissions
+ */
+export declare const getCurrentPermissions: () => Promise<ApiResponse<Permissions>>;
+/**
+ * Get logged user accessible namespaces
+ *
+ * Needs `namespaces[namespaceId].auth-get-namespaces` permission
+ *
+ * @returns Permissions
+ */
+export declare const getCurrentNamespaces: () => Promise<ApiResponse<(Namespace & TaskCount)[]>>;
+export {};

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

@@ -0,0 +1 @@
+export { type Access, type Membership, type User, type Permissions, login, logout, isLogged, getCurrentUser, getCurrentNamespaces, getCurrentPermissions, } from './auth';

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

@@ -0,0 +1,102 @@
+import { type ApiResponse } from '../lib/axios';
+interface RawCron {
+    name: string;
+    running: boolean;
+    nextRun?: string;
+    lastRun?: string;
+}
+export interface Cron extends Omit<RawCron, 'nextRun' | 'lastRun'> {
+    nextRun?: Date;
+    lastRun?: Date;
+}
+export interface InputCron extends Pick<Cron, 'running'> {
+}
+/**
+ * Get all available crons
+ *
+ * Needs `general.crons-get` permission
+ *
+ * @returns All crons' info
+ */
+export declare const getAllCrons: () => Promise<ApiResponse<Cron[]>>;
+/**
+ * Get cron info
+ *
+ * Needs `general.crons-get-cron` permission
+ *
+ * @param cronOrName Cron or Cron name
+ *
+ * @returns Cron's info
+ */
+export declare const getCron: (cronOrName: Cron | Cron['name']) => Promise<ApiResponse<Cron>>;
+/**
+ * Start cron
+ *
+ * Needs `general.crons-put-cron-start` permission
+ *
+ * @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<{
+    content: Cron;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+/**
+ * Stop cron
+ *
+ * Needs `general.crons-put-cron-stop` permission
+ *
+ * @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 updateCron: (cron: Partial<InputCron> & {
+    name: Cron['name'];
+}) => Promise<{
+    content: Cron;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+/**
+ * Force cron to run
+ *
+ * Needs `general.crons-post-cron-force` permission
+ *
+ * @param cronOrName Cron or Cron name
+ *
+ * @returns Cron's info
+ */
+export declare const forceCron: (cronOrName: Cron | Cron['name']) => Promise<{
+    content: Cron;
+    status: {
+        code: number;
+        message: string;
+    };
+}>;
+export {};

package/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/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/types/src/modules/elastic.public.d.ts

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

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

@@ -0,0 +1,53 @@
+interface PingResultSuccess {
+    name: string;
+    status: true;
+    elapsedTime: number;
+    statusCode: number;
+}
+interface PingResultFail {
+    name: string;
+    status: false;
+    error: string;
+}
+export type PingResult = PingResultSuccess | PingResultFail;
+/**
+ * Get all services connected to current
+ *
+ * Needs `general.health-get` permission
+ *
+ * @returns The current service & the name of connected ones
+ */
+export declare const getAllConnectedServices: () => Promise<import("../lib/axios").ApiResponse<{
+    current: string;
+    currentVersion: string;
+    services: PingResult['name'][];
+}>>;
+/**
+ * Check connection for all connected service from current
+ *
+ * Needs `general.health-get-all` permission
+ *
+ * @returns The connection status for all services
+ */
+export declare const checkAllConnectedService: () => Promise<import("../lib/axios").ApiResponse<PingResult[]>>;
+/**
+ * Check connection of a specific service from current
+ *
+ * Needs `general.health-get-service` permission
+ *
+ * @param service The name of the service
+ *
+ * @returns The connection status of the service from current
+ */
+export declare const checkConnectedService: (service: PingResult['name']) => Promise<import("../lib/axios").ApiResponse<PingResult>>;
+/**
+ * Check connection of current service
+ *
+ * It's useful when the app will have limited connection, or if you just want the processing time.
+ *
+ * Needs `general.health-get-all` & `general.health-get-service` permission
+ *
+ * @returns The connection status of current service
+ */
+export declare const checkCurrentService: () => Promise<import("../lib/axios").ApiResponse<PingResult>>;
+export {};

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

@@ -0,0 +1 @@
+export { type PingResult, getAllConnectedServices, checkAllConnectedService, checkConnectedService, checkCurrentService, } from './health';

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

@@ -0,0 +1,38 @@
+import { type PaginatedApiResponse } from '../lib/axios';
+import { type TaskWithNamespace } from './tasks.base';
+export interface RawHistory {
+    id: string;
+    taskId: string;
+    type: string;
+    message: string;
+    data?: object;
+    createdAt: string;
+}
+export interface History extends Omit<RawHistory, 'createdAt'> {
+    createdAt: Date;
+}
+export interface HistoryWithTask extends Omit<History, 'taskId'> {
+    task: TaskWithNamespace;
+}
+/**
+ * Transform raw data from JSON, to JS usable data
+ *
+ * @param entry Raw history entry
+ *
+ * @returns Parsed history entry
+ */
+export declare const parseHistory: (entry: RawHistory) => History;
+/**
+ * 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?: History['id'];
+    count?: number;
+}, namespaces?: string[]) => Promise<PaginatedApiResponse<HistoryWithTask[]>>;

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

@@ -0,0 +1 @@
+export { type History, type HistoryWithTask, getAllEntries, } from './history';

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

@@ -0,0 +1,29 @@
+export interface RawNamespace {
+    id: string;
+    name: string;
+    logoId?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+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
+ *
+ * @param namespace Raw namespace
+ *
+ * @returns Parsed namespace
+ */
+export declare const parseNamespace: (namespace: RawNamespace) => Namespace;

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

@@ -0,0 +1 @@
+export { type Namespace, } from './namespaces';

package/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/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';