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

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

@@ -0,0 +1,194 @@
+import { Stream } from 'stream';
+import { type Period, type RawPeriod } from '../lib/utils';
+import { getJob, type FullJob, type Job } 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[];
+    };
+    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 taskId 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?: {
+    /**
+     * 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'];
+};
+/**
+ * Start generation of a report and track progress
+ *
+ * Needs `namespaces[namespaceId].tasks-post-task-run`
+ * & `namespaces[namespaceId].queues-get-queue-jobs-jobId` permissions
+ *
+ * @param taskId 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: (taskId: string, 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>;
+interface ResponseTypeMap {
+    arraybuffer: ArrayBuffer;
+    blob: Blob;
+    json: object;
+    text: string;
+    stream: Stream;
+}
+type GetJobParams = Parameters<typeof getJob>;
+/**
+ * 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 | undefined, 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 queueName Name of queue where job is
+ * @param jobId Id of the job 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]>;
+/**
+ * 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 queueName Name of queue where job is
+ * @param jobId Id of the job 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>;
+/**
+ * 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 | undefined) => 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 queueName Name of queue where job is
+ * @param jobId Id of the job 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 {};

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

@@ -0,0 +1 @@
+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

@@ -0,0 +1,17 @@
+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

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

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

@@ -0,0 +1,48 @@
+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;

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

@@ -0,0 +1,124 @@
+import { type ApiResponse, type PaginatedApiResponse } from '../lib/axios';
+import { type History, type RawHistory } from './history';
+import type { Namespace } from './namespaces';
+import { type Task, type RawTaskWithNamespace, type TaskWithNamespace } from './tasks.base';
+import type { Layout } from './templates';
+interface AdditionalRawTaskData {
+    template: {
+        extends: string;
+        fetchOptions?: object;
+        inserts?: (Layout & {
+            at: number;
+        })[];
+    };
+    targets: string[];
+    history: RawHistory[];
+}
+interface AdditionalTaskData extends Omit<AdditionalRawTaskData, 'history'> {
+    history: History[];
+}
+export interface RawFullTask extends RawTaskWithNamespace, AdditionalRawTaskData {
+}
+export interface FullTask extends TaskWithNamespace, AdditionalTaskData {
+}
+export interface InputTask extends Pick<FullTask, 'name' | 'template' | 'targets' | 'recurrence'> {
+    namespace?: Task['namespaceId'];
+    nextRun?: FullTask['nextRun'];
+    enabled?: FullTask['enabled'];
+}
+/**
+ * Get all available tasks
+ *
+ * Needs `namespaces[namespaceId].tasks-get` permission
+ *
+ * @param paginationOpts Options for pagination
+ * @param namespaces
+ *
+ * @returns All tasks' info
+ */
+export declare const getAllTasks: (paginationOpts?: {
+    previous?: Task['id'];
+    count?: number;
+}, namespaces?: Namespace['id'][]) => Promise<PaginatedApiResponse<Task[]>>;
+/**
+ * Create a new task
+ *
+ * Needs `namespaces[namespaceId].tasks-post` permission
+ *
+ * @param task Task's data
+ * @param namespaces
+ *
+ * @returns Created task's info
+ */
+export declare const createTask: (task: InputTask, namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+/**
+ * Get task info
+ *
+ * Needs `namespaces[namespaceId].tasks-get-task` permission
+ *
+ * @param id Task's id
+ * @param namespaces
+ *
+ * @returns Task's info
+ */
+export declare const getTask: (id: 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 namespaces
+ *
+ * @returns Updated/Created Task's info
+ */
+export declare const upsertTask: (id: Task['id'], task: InputTask, 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 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>>;
+/**
+ * Delete a task
+ *
+ * Needs `namespaces[namespaceId].tasks-delete-task` permission
+ *
+ * @param id Task's id
+ * @param namespaces
+ *
+ * @returns Deleted Task's info
+ */
+export declare const deleteTask: (id: 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 namespaces
+ *
+ * @returns Updated task's info
+ */
+export declare const enableTask: (id: 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 namespaces
+ *
+ * @returns Updated task's info
+ */
+export declare const disableTask: (id: Task['id'], namespaces?: Namespace['id'][]) => Promise<ApiResponse<FullTask>>;
+export {};

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

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

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

@@ -0,0 +1,120 @@
+import { type ApiResponse } from '../lib/axios';
+type JsonObject = {
+    [Key in string]?: JsonValue;
+};
+type JsonArray = JsonValue[];
+type JsonValue = string | number | boolean | JsonObject | JsonArray | null;
+export interface Figure {
+    type: string;
+    data?: string | unknown[];
+    params: JsonObject;
+    slots?: number[];
+}
+export interface Layout {
+    data?: unknown;
+    fetcher?: string;
+    fetchOptions?: JsonObject;
+    figures: Figure[];
+}
+export interface RawTemplate {
+    name: string;
+    renderer: string;
+    pageCount: number;
+    tags: {
+        name: string;
+        color?: string;
+    }[];
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface Template extends Omit<RawTemplate, 'createdAt' | 'updatedAt'> {
+    createdAt: Date;
+    updatedAt?: Date;
+}
+export interface RawFullTemplate extends RawTemplate {
+    body: {
+        renderer?: string;
+        renderOptions?: JsonObject;
+        fetchOptions?: JsonObject;
+        layouts: Layout[];
+    };
+}
+export interface FullTemplate extends Omit<RawFullTemplate, 'createdAt' | 'updatedAt'> {
+    createdAt: Date;
+    updatedAt?: Date;
+}
+export interface InputTemplate {
+    body: FullTemplate['body'];
+    tags: FullTemplate['tags'];
+}
+/**
+ * Get all available templates
+ *
+ * Needs `general.templates-get` permission
+ *
+ * @returns All templates' info
+ */
+export declare const getAllTemplates: () => Promise<ApiResponse<Template[]>>;
+/**
+ * Get template info
+ *
+ * Needs `general.templates-get-name(*)` permission
+ *
+ * @param name Template's name
+ *
+ * @returns Template info
+ */
+export declare const getTemplate: (name: Template['name']) => Promise<ApiResponse<FullTemplate>>;
+/**
+ * Create a new template
+ *
+ * Needs `general.templates-post` permission
+ *
+ * @param template Template's data
+ * @param namespaces
+ *
+ * @deprecated use `upsertTemplate` instead
+ *
+ * @returns Created template's info
+ */
+export declare const createTemplate: (template: InputTemplate & {
+    name: Template['name'];
+}) => Promise<ApiResponse<FullTemplate>>;
+/**
+ * Update or create a template
+ *
+ * Needs `general.templates-put-name(*)` permission
+ *
+ * @param id Template's id
+ * @param template Template's data
+ * @param namespaces
+ *
+ * @returns Updated/Created Template's info
+ */
+export declare const upsertTemplate: (name: Template['name'], template: InputTemplate) => Promise<ApiResponse<FullTemplate>>;
+/**
+ * Update a template
+ *
+ * Needs `general.templates-put-name(*)` permission
+ *
+ * @param id Template's id
+ * @param template New Template's data
+ * @param namespaces
+ *
+ * @deprecated use `upsertTemplate` instead
+ *
+ * @returns Updated Template's info
+ */
+export declare const updateTemplate: (name: Template['name'], template: InputTemplate) => Promise<ApiResponse<FullTemplate>>;
+/**
+ * Delete a template
+ *
+ * Needs `general.templates-delete-name(*)` permission
+ *
+ * @param id Template's id
+ * @param namespaces
+ *
+ * @returns Deleted Template's info
+ */
+export declare const deleteTemplate: (name: Template['name']) => Promise<void>;
+export {};

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

@@ -0,0 +1 @@
+export { type Figure, type Layout, type Template, type FullTemplate, type InputTemplate, getAllTemplates, getTemplate, createTemplate, updateTemplate, upsertTemplate, deleteTemplate, } from './templates';

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@ezpaarse-project/ezreeport-sdk-js",
+  "version": "1.0.0-beta.1",
+  "description": "JS SDK to communicate with ezReeport API",
+  "homepage": "https://github.com/ezpaarse-project/ezreeport#readme",
+  "bugs": {
+    "url": "https://github.com/ezpaarse-project/ezreeport/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/ezpaarse-project/ezreeport.git"
+  },
+  "license": "CeCILL",
+  "author": "oxypomme",
+  "exports": {
+    "browser": {
+      "import": "./dist/browser/ezreeport-sdk-js.mjs",
+      "require": "./dist/browser/ezreeport-sdk-js.umd.js"
+    },
+    "node": {
+      "default": "./dist/node/index.js"
+    }
+  },
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "run-s build:web build:node build:types",
+    "build:node-vite": "tsc && BUILD_TARGET=node vite build",
+    "build:node": "tsc --project tsconfig.node.json",
+    "build:types": "tsc && BUILD_TARGET=types vite build",
+    "build:web": "tsc && BUILD_TARGET=browser vite build",
+    "lint": "eslint --fix .",
+    "test": "npm run build && npm -w ezreeport-tests run test:sdk"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "axios": "^1.3.5",
+    "date-fns": "^2.29.3",
+    "events": "^3.3.0",
+    "typescript": "^5.0.4",
+    "vite": "^4.2.1",
+    "vite-plugin-dts": "^2.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.15.11"
+  },
+  "engines": {
+    "node": "^16 || ^18"
+  }
+}