@ezpaarse-project/ezreeport-sdk-js 1.0.0-beta.5 → 1.0.0-beta.7

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

@@ -1,125 +0,0 @@
-import { type ApiResponse, type PaginatedApiResponse } from '../lib/axios';
-import type { JsonObject } from '../lib/utils';
-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?: JsonObject;
-        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

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

@@ -1,115 +0,0 @@
-import { type ApiResponse } from '../lib/axios';
-import type { JsonObject } from '../lib/utils';
-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>;