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

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

@@ -1,102 +0,0 @@
-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/modules/crons.public.d.ts

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

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

@@ -1,33 +0,0 @@
-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>>>;
-/**
- * Resolve index to get list of matched indices
- *
- * Needs `namespaces[namespaceId].elastic-get-indices-_resolve-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 resolveIndex: (index: string, namespace?: Namespace['id']) => Promise<import("../lib/axios").ApiResponse<string[]>>;

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

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

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

@@ -1,53 +0,0 @@
-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/modules/health.public.d.ts

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

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

@@ -1,29 +0,0 @@
-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/modules/namespaces.public.d.ts

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

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

@@ -1,120 +0,0 @@
-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: Job<Data> | Job<Data>['id'], 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: Job<Data> | Job<Data>['id'], namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
-export {};

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

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

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

@@ -1,204 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Stream } from 'stream';
-import { type Period, type RawPeriod } from '../lib/utils';
-import { type FullJob, type Job, type Queue } from './queues';
-import type { RawFullTask } from './tasks';
-interface RawReportResultDetail {
-    createdAt: string;
-    destroyAt: string;
-    took: number;
-    taskId: string;
-    files: {
-        detail: string;
-        report?: string;
-        debug?: string;
-    };
-    sendingTo?: string[];
-    period?: RawPeriod;
-    runAs?: string;
-    stats?: object;
-    error?: {
-        message: string;
-        stack: string[];
-        cause?: {
-            type: string;
-            layout: number;
-            figure?: number;
-        };
-    };
-    meta?: unknown;
-}
-export interface ReportResultDetail extends Omit<RawReportResultDetail, 'createdAt' | 'destroyAt' | 'period'> {
-    createdAt: Date;
-    destroyAt: Date;
-    period?: Period;
-}
-interface RawReportResult {
-    success: boolean;
-    detail: RawReportResultDetail;
-}
-export interface ReportResult extends Omit<RawReportResult, 'detail'> {
-    detail: ReportResultDetail;
-}
-interface RawReportData {
-    task: RawFullTask;
-    origin: string;
-    writeHistory?: boolean;
-    customPeriod?: RawPeriod;
-    debug?: boolean;
-}
-type ReportJob = Job<RawReportData>;
-type FullReportJob = FullJob<RawReportData, RawReportResult>;
-/**
- * Start generation of a report
- *
- * Needs `namespaces[namespaceId].tasks-post-task-_run` permission
- *
- * @param taskOrId Task or id of the task
- * @param params Other params for overriding default
- * @param namespaces
- *
- * @returns Job info to track progress
- */
-export declare const startGeneration: (taskOrId: RawFullTask | RawFullTask['id'], params?: {
-    /**
-     * Override targets of task. Also enable first level of debugging
-     * (disable generation history)
-     */
-    testEmails?: string[];
-    /**
-     * Override period, must match task's recurrence
-     */
-    period?: Period;
-}, namespaces?: string[]) => Promise<import("../lib/axios").ApiResponse<ReportJob>>;
-export type GenerationStartedEvent = {
-    id: string | number;
-    queue: string;
-};
-export type GenerationProgressEvent = {
-    progress: number;
-    status: FullReportJob['status'];
-};
-type GenerationEvents = {
-    'started': [GenerationStartedEvent];
-    'progress': [GenerationProgressEvent];
-};
-/**
- * Start generation of a report and track progress
- *
- * Needs `namespaces[namespaceId].tasks-post-task-run`
- * & `namespaces[namespaceId].queues-get-queue-jobs-jobId` permissions
- *
- * @param taskOrId Task or id of the task
- * @param params Other params for overriding default
- * @param namespaces
- *
- * @fires #started When generation started. See `GenerationStartedEvent`.
- * @fires #progress When generation progress. See `GenerationProgressEvent`. Job's progress is
- * between 0 and 1
- *
- * @throws If job's fails. **Not if generation fails !**
- *
- * @returns When generation ends, with detail
- */
-export declare const startAndListenGeneration: (taskOrId: string | RawFullTask, params?: {
-    /**
-     * Override targets of task. Also enable first level of debugging
-     * (disable generation history)
-     */
-    testEmails?: string[] | undefined;
-    /**
-     * Override period, must match task's recurrence
-     */
-    period?: Period | undefined;
-} | undefined, namespaces?: string[] | undefined) => import("../lib/promises").EventfulPromise<ReportResult, GenerationEvents>;
-interface ResponseTypeMap {
-    arraybuffer: ArrayBuffer;
-    blob: Blob;
-    json: object;
-    text: string;
-    stream: Stream;
-}
-/**
- * Get report main file (the result) by giving the report's name
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission
- *
- * @param name Name of the report
- * @param ext The extension of the result (renderer dependent)
- * @param namespaces
- * @param responseType Wanted response type
- *
- * @returns The report's content
- */
-export declare const getReportFileByName: <Result extends keyof ResponseTypeMap = "text">(name: string, namespaces?: string[], responseType?: Result, ext?: string) => Promise<ResponseTypeMap[Result]>;
-/**
- * Get report main file (the result) by giving job's info
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
- * & `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
- * @param responseType Wanted response type
- *
- * @returns The report's content
- */
-export declare const getReportFileByJob: <Result extends keyof ResponseTypeMap = "text">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
-/**
- * Get report detail by giving the report's name
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission
- *
- * @param name Name of the report
- * @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 getReportDetailByName: (name: string, namespaces?: string[], responseType?: keyof ResponseTypeMap) => Promise<ReportResult>;
-/**
- * Get report detail by giving job's info
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
- * & `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
- * @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: 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
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission
- *
- * @param name Name of the report
- * @param namespaces
- * @param responseType Wanted response type
- *
- * @returns The debug's content
- */
-export declare const getReportDebugByName: <Result extends keyof ResponseTypeMap = "json">(name: string, namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
-/**
- * Get report debug file by giving job's info
- *
- * Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
- * & `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
- * @param responseType Wanted response type
- *
- * @returns The debug's content
- */
-export declare const getReportDebugByJob: <Result extends keyof ResponseTypeMap = "json">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
-export {};

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

@@ -1 +0,0 @@
-export { type ReportResultDetail, type ReportResult, type GenerationStartedEvent, type GenerationProgressEvent, startGeneration, startAndListenGeneration, getReportFileByName, getReportFileByJob, getReportDetailByName, getReportDetailByJob, getReportDebugByName, getReportDebugByJob, } from './reports';

package/dist/types/modules/setup.d.ts

@@ -1,17 +0,0 @@
-export { isLogged, login, logout } from './auth';
-/**
- * Set API url to axios
- *
- * @param url The url
- */
-export declare const setURL: (url: string) => void;
-/**
- * Unset API url from axios
- */
-export declare const unsetURL: () => void;
-/**
- * Check if API url is setup in axios
- *
- * @returns If API url is setup
- */
-export declare const isURLset: () => boolean;

package/dist/types/modules/setup.public.d.ts

@@ -1,2 +0,0 @@
-export { setURL, unsetURL, isURLset, } from './setup';
-export { isLogged, login, logout, } from './auth';

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

@@ -1,48 +0,0 @@
-import { type RawNamespace, type Namespace } from './namespaces';
-export declare enum Recurrence {
-    DAILY = "DAILY",
-    WEEKLY = "WEEKLY",
-    MONTHLY = "MONTHLY",
-    QUARTERLY = "QUARTERLY",
-    BIENNIAL = "BIENNIAL",
-    YEARLY = "YEARLY"
-}
-export interface RawTask {
-    id: string;
-    name: string;
-    namespaceId: string;
-    recurrence: Recurrence;
-    nextRun: string;
-    lastRun?: string;
-    enabled: boolean;
-    createdAt: string;
-    updatedAt?: string;
-}
-export interface Task extends Omit<RawTask, 'nextRun' | 'lastRun' | 'createdAt' | 'updatedAt'> {
-    nextRun: Date;
-    lastRun?: Date;
-    createdAt: Date;
-    updatedAt?: Date;
-}
-/**
- * Transform raw data from JSON, to JS usable data
- *
- * @param task Raw task
- *
- * @returns Parsed task
- */
-export declare const parseTask: (task: RawTask) => Task;
-export interface RawTaskWithNamespace extends Omit<RawTask, 'namespaceId'> {
-    namespace: RawNamespace;
-}
-export interface TaskWithNamespace extends Omit<Task, 'namespaceId'> {
-    namespace: Namespace;
-}
-/**
- * Transform raw data from JSON, to JS usable data
- *
- * @param task Raw task with namespace
- *
- * @returns Parsed task with namespace
- */
-export declare const parseTaskWithNamespace: (task: RawTaskWithNamespace) => TaskWithNamespace;