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

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

@@ -0,0 +1,153 @@
+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/types/src/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

@@ -1,6 +1,6 @@
 {
   "name": "@ezpaarse-project/ezreeport-sdk-js",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.10",
   "description": "JS SDK to communicate with ezReeport API",
   "homepage": "https://github.com/ezpaarse-project/ezreeport#readme",
   "bugs": {
@@ -18,19 +18,21 @@
       "require": "./dist/browser/ezreeport-sdk-js.umd.js"
     },
     "node": {
-      "default": "./dist/node/index.js"
+      "default": "./dist/node/src/index.js"
     }
   },
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/types/src/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "run-s build:web build:node build:types",
+    "build": "run-s build:web build:node build:docs",
     "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",
+    "build:docs": "typedoc src/index.ts",
+    "docs": "vite docs --open",
+    "dev": "run-p \"build:docs -- --watch\" docs",
     "lint": "eslint --fix .",
     "test": "npm run build && npm -w ezreeport-tests run test:sdk"
   },
@@ -40,15 +42,15 @@
     ]
   },
   "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"
+    "axios": "^1.6.4",
+    "date-fns": "^3.0.6",
+    "events": "^3.3.0"
   },
   "devDependencies": {
-    "@types/node": "^18.15.11"
+    "@types/node": "^20.10.6",
+    "typedoc": "^0.25.6",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.10"
   },
   "engines": {
     "node": "^16 || ^18"

package/CHANGELOG.md

@@ -1,42 +0,0 @@
-# @ezpaarse-project/ezreeport-sdk-js 1.0.0-beta.1 (2023-05-02)
-
-
-### Bug Fixes
-
-* **sdk:** fix type on getAllTemplates ([4309030](https://github.com/ezpaarse-project/ezreeport/commit/4309030938b47d7289a72736b84d99540bd40784))
-* **sdk:** fixed export of crons methods ([46d1dbc](https://github.com/ezpaarse-project/ezreeport/commit/46d1dbc081a1c2206c2a63737088c4627990f7ca))
-* **sdk:** fixed export of reccurence ([7d88766](https://github.com/ezpaarse-project/ezreeport/commit/7d8876676256de55766b4724c57c5c9b27effe5e))
-* **sdk:** fixed namespace in task in history ([a992199](https://github.com/ezpaarse-project/ezreeport/commit/a992199ecb4c2748112fe928ba93f5e9a6e8a4df))
-* **sdk:** fixed type of InputTask ([3feaade](https://github.com/ezpaarse-project/ezreeport/commit/3feaade67d014cf24a47d222af0a4a284a0c466f))
-* **sdk:** fixed type of paginated data ([7113f7d](https://github.com/ezpaarse-project/ezreeport/commit/7113f7d42d2f0e98f351202d8efcc47126f7c0e3))
-* **sdk:** fixed type on figures ([74e3467](https://github.com/ezpaarse-project/ezreeport/commit/74e3467b3edb2a698ccb460a9da4b32760b0c5d8))
-* **sdk:** fixed types by replacing objects with json values ([ae1a501](https://github.com/ezpaarse-project/ezreeport/commit/ae1a50192531308aa097cd3f7f2c8218cc2c880d))
-* **sdk:** fixed types on report ([89542e1](https://github.com/ezpaarse-project/ezreeport/commit/89542e1c547dbbfa67f4685020e55a18c9b0bb14))
-* **sdk:** fixed wrong name for updating template ([b75dad6](https://github.com/ezpaarse-project/ezreeport/commit/b75dad69899df59cefeac246e33f9243307cf200))
-* **sdk:** updating auth module following API ([947084d](https://github.com/ezpaarse-project/ezreeport/commit/947084d8827c41c2ec4fbb3ff64eaf24a5bd9fd5))
-* **vue:** fixed generation permissions ([afbeea2](https://github.com/ezpaarse-project/ezreeport/commit/afbeea21c38da0d2fe7686f0b88666b4abcf3bde))
-
-
-### Features
-
-* **sdk:** added list of user's available institution ([80412de](https://github.com/ezpaarse-project/ezreeport/commit/80412de76f1f01f1f1692f17070cf24709cc8d40))
-* **sdk:** added support for responseType with reports ([4997076](https://github.com/ezpaarse-project/ezreeport/commit/4997076b67722fd256c7cd0e9c8fc8e9c44144a1))
-* **sdk:** added support for tags in template ([d9285b0](https://github.com/ezpaarse-project/ezreeport/commit/d9285b083c426b96fcc636cb0bf4ae7a0026dd99))
-* **sdk:** added template management ([e67ae37](https://github.com/ezpaarse-project/ezreeport/commit/e67ae37a3524ba4490bc328b7939926537dbd811))
-* **sdk:** can retrieve version ([e0eea2c](https://github.com/ezpaarse-project/ezreeport/commit/e0eea2ca07c3854e597f84eb534b43969f451fc8))
-* **sdk:** delete no longer returns something ([743308f](https://github.com/ezpaarse-project/ezreeport/commit/743308f52e75ad329fd067c9282bbb80dbbcb42a))
-* **sdk:** following api changes about queues ([d49fd3f](https://github.com/ezpaarse-project/ezreeport/commit/d49fd3f99243186cdc697f8f026af565dc569bad))
-* **sdk:** following reporting api changes ([4a52e7c](https://github.com/ezpaarse-project/ezreeport/commit/4a52e7c2a5ffd83f3ee2d471484d4b49115adcbb))
-* **sdk:** moved institutions to dedicated modules ([4e81396](https://github.com/ezpaarse-project/ezreeport/commit/4e813967ab1faff1f26728878e25a456600e9054))
-* **sdk:** task is now included in history list ([d094471](https://github.com/ezpaarse-project/ezreeport/commit/d094471d702cbef36f2f58fde9f3049c327a0ccc))
-* **sdk:** using namespaces instead of institutions, following API ([9950309](https://github.com/ezpaarse-project/ezreeport/commit/99503094c972aede02c18677b3c81e718d820214))
-* **vue:** added base to work on vue plugin ([7d2dd35](https://github.com/ezpaarse-project/ezreeport/commit/7d2dd35f2c157115ccbf706860bdb9473196e9fd))
-* **vue:** added global data for sdk ([f2ad20f](https://github.com/ezpaarse-project/ezreeport/commit/f2ad20f5beaf446d200ad0987cad567495fba0c8))
-* **vue:** moved from `Histoire` to `Storybook` ([4f41efe](https://github.com/ezpaarse-project/ezreeport/commit/4f41efefcd75c063fbc5dbfc63f03d15c191fb6c))
-* **vue:** switched to the new permission system ([a0a59a0](https://github.com/ezpaarse-project/ezreeport/commit/a0a59a050a216f1ca4a17060fb57395deb5c443a))
-
-
-### BREAKING CHANGES
-
-* **sdk:** institution parameter is now an array of strings
-* **sdk:** institution module is dropped

package/dist/types/lib/promises.d.ts

@@ -1,18 +0,0 @@
-import EventEmitter from 'events';
-interface EventEmitterBase {
-    on: (...p: Parameters<EventEmitter['on']>) => this;
-    once: (...p: Parameters<EventEmitter['once']>) => this;
-    off: (...p: Parameters<EventEmitter['off']>) => this;
-    emit: (...p: Parameters<EventEmitter['emit']>) => this;
-}
-export type EventfulPromise<T> = Promise<T> & EventEmitterBase;
-/**
- * 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>(executor: (emitter: EventEmitter | EventEmitterBase) => Promise<T>, emitter?: EventEmitter) => EventfulPromise<T>;
-export default createEventfulPromise;

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

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

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

@@ -1,56 +0,0 @@
-import { type ApiResponse } from '../lib/axios';
-interface RawInstitution {
-    id: string;
-    name: string;
-    website?: string;
-    uai?: string;
-    auto: {
-        ezmesure: boolean;
-        ezpaarse: boolean;
-        report: boolean;
-        sushi?: boolean;
-    };
-    validated?: boolean;
-    indexCount?: number;
-    domains?: string[];
-    logoId?: string;
-    updatedAt?: string;
-    createdAt: string;
-    acronym?: string;
-    city?: string;
-    type?: string;
-    linkedinUrl?: string;
-    facebookUrl?: string;
-    twitterUrl?: string;
-    creator?: string;
-    youtubeUrl?: string;
-    indexPrefix?: string;
-    role?: string;
-    space?: string;
-    docContactName?: string;
-    techContactName?: string;
-    hidePartner?: boolean;
-    sushiReadySince?: string;
-}
-export interface Institution extends Omit<RawInstitution, 'updatedAt' | 'createdAt' | 'sushiReadySince'> {
-    updatedAt?: Date;
-    createdAt: Date;
-    sushiReadySince?: Date;
-}
-/**
- * Get all available institutions for authed user
- *
- * Needs `institutions-get` permission
- *
- * @returns Available institutions
- */
-export declare const getInstitutions: () => Promise<ApiResponse<Institution[]>>;
-/**
- * Get specific institution that is available for authed user
- *
- * Needs `institutions-get-id` permission
- *
- * @returns Available institution
- */
-export declare const getInstitution: (id: Institution['id']) => Promise<ApiResponse<Institution>>;
-export {};

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

@@ -1,93 +0,0 @@
-import { type PaginatedApiResponse, type ApiResponse } from '../lib/axios';
-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;
-}
-/**
- * Get all available queues
- *
- * Needs `general.queues-get` permission
- *
- * @returns All queues' names
- */
-export declare const getAllQueues: () => Promise<ApiResponse<Queue[]>>;
-/**
- * Pause queue
- *
- * Needs `general.queues-put-queue-pause` permission
- *
- * @param queueName Name of the queue
- *
- * @returns queue info
- */
-export declare const pauseQueue: (queueName: string) => Promise<ApiResponse<Queue>>;
-/**
- * Resume queue
- *
- * Needs `general.queues-put-queue-resume` permission
- *
- * @param queueName Name of the queue
- *
- * @returns queue info
- */
-export declare const resumeQueue: (queueName: string) => Promise<ApiResponse<Queue>>;
-/**
- * Get queue info
- *
- * Needs `general.queues-get-queue-jobs` permission
- *
- * @param queueName Name of the queue
- *
- * @returns queue info
- */
-export declare const getQueueJobs: <Data, Result>(queueName: string, paginationOpts?: {
-    previous?: string | number | undefined;
-    count?: number | undefined;
-} | undefined) => Promise<PaginatedApiResponse<FullJob<Data, Result>[]>>;
-/**
- * Get job info
- *
- * Needs `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
- *
- * @returns Job full info
- */
-export declare const getJob: <Data, Result>(queueName: string, jobId: string | number, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
-/**
- * Retry job that failed
- *
- * Needs `namespaces[namespaceId].queues-post-queue-jobs-jobId-retry` permission
- *
- * @param queueName Name of queue where job is
- * @param jobId Id of the job in queue
- * @param namespaces
- *
- * @returns queue info
- */
-export declare const retryJob: <Data, Result>(queueName: string, jobId: string | number, 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, getAllQueues, pauseQueue, resumeQueue, getQueueJobs, getJob, retryJob, } from './queues';

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

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

@@ -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,120 +0,0 @@
-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 {};