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

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

@@ -1,153 +0,0 @@
-import { type ApiResponse } from '../lib/axios';
-import { type RawTask, type Task } from './tasks.base';
-interface FigureFetchOptions {
-    fetchCount?: string;
-    filters?: Record<string, any>;
-}
-interface FigureFetchOptionsAggs extends FigureFetchOptions {
-    aggs?: Record<string, any>[];
-}
-interface FigureFetchOptionsBuckets extends FigureFetchOptions {
-    buckets?: Record<string, any>[];
-    metric?: Record<string, any>;
-}
-export interface Figure {
-    type: string;
-    data?: string | unknown[];
-    params: Record<string, any>;
-    fetchOptions?: FigureFetchOptionsAggs | FigureFetchOptionsBuckets;
-    slots?: number[];
-}
-export interface Layout {
-    data?: unknown;
-    fetcher?: string;
-    fetchOptions?: {
-        fetchCount?: string;
-        filters?: Record<string, any>;
-    };
-    figures: Figure[];
-}
-export interface RawTemplate {
-    id: string;
-    name: string;
-    pageCount: number;
-    tags: {
-        name: string;
-        color?: string;
-    }[];
-    createdAt: string;
-    updatedAt?: string;
-}
-export interface Template extends Omit<RawTemplate, 'createdAt' | 'updatedAt'> {
-    createdAt: Date;
-    updatedAt?: Date;
-}
-/**
- * Transform raw data from JSON, to JS usable data
- *
- * @param template Raw template
- *
- * @returns Parsed template
- */
-export declare const parseTemplate: (template: RawTemplate) => Template;
-export interface RawFullTemplate extends RawTemplate {
-    body: {
-        renderer?: string;
-        renderOptions?: {
-            grid?: {
-                cols: number;
-                rows: number;
-            };
-        };
-        fetchOptions?: {
-            filters?: Record<string, any>;
-            index?: string;
-            dateField: string;
-        };
-        layouts: Layout[];
-    };
-    tasks: RawTask[];
-}
-export interface FullTemplate extends Omit<RawFullTemplate, 'tasks' | 'createdAt' | 'updatedAt'> {
-    createdAt: Date;
-    updatedAt?: Date;
-    tasks: Task[];
-}
-export interface InputTemplate {
-    name: FullTemplate['name'];
-    body: FullTemplate['body'];
-    tags: FullTemplate['tags'];
-}
-type TemplateListResponse = ApiResponse<Template[]> & {
-    meta: {
-        default: string;
-    };
-};
-/**
- * Get all available templates
- *
- * Needs `general.templates-get` permission
- *
- * @returns All templates' info
- */
-export declare const getAllTemplates: () => Promise<TemplateListResponse>;
-/**
- * Get template info
- *
- * Needs `general.templates-get-template` permission
- *
- * @param templateOrId Template or Template's id
- *
- * @returns Template info
- */
-export declare const getTemplate: (templateOrId: Template | Template['id']) => Promise<ApiResponse<FullTemplate>>;
-/**
- * Create a new template
- *
- * Needs `general.templates-post` permission
- *
- * @param template Template's data
- * @param namespaces
- *
- * @returns Created template's info
- */
-export declare const createTemplate: (template: InputTemplate) => Promise<ApiResponse<FullTemplate>>;
-/**
- * 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
- */
-export declare const upsertTemplate: (template: InputTemplate & {
-    id: Template['id'];
-}) => Promise<ApiResponse<FullTemplate>>;
-/**
- * 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
- */
-export declare const updateTemplate: (template: InputTemplate & {
-    id: Template['id'];
-}) => Promise<ApiResponse<FullTemplate>>;
-/**
- * Delete a template
- *
- * Needs `general.templates-delete-template` permission
- *
- * @param templateOrId Template or Template's id
- * @param namespaces
- */
-export declare const deleteTemplate: (templateOrId: Template | Template['id']) => Promise<void>;
-export {};

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

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