@ezpaarse-project/ezreeport-sdk-js 3.0.0 → 3.1.0

package/dist/index-DIYCM-ZC.d.mts

@@ -0,0 +1,73 @@
+import { n as SdkPaginated, t as ApiRequestOptions } from "./api-CAycTX8Z.mjs";
+
+//#region src/modules/template-tags/types.d.ts
+/**
+ * Tag of a template
+ */
+interface TemplateTag {
+  /** Tag id */
+  id: string;
+  /** Tag name */
+  name: string;
+  /** Tag color. Should be in hex format */
+  color?: string;
+}
+/**
+ * Data needed to create/edit a tag
+ */
+type InputTemplateTag = Omit<TemplateTag, 'id'>;
+//#endregion
+//#region src/modules/template-tags/methods.d.ts
+type PaginatedTemplateTags = SdkPaginated<TemplateTag> & {
+  meta: {
+    default: string;
+  };
+};
+/**
+ * Get all available template tags
+ *
+ * @returns All template tags' info
+ */
+declare function getAllTemplateTags(opts?: ApiRequestOptions & {
+  include?: string[];
+}): Promise<PaginatedTemplateTags>;
+/**
+ * Get template tag info
+ *
+ * @param tagOrId Template tag or template tag's id
+ *
+ * @returns template tag info
+ */
+declare function getTemplateTag(tagOrId: TemplateTag | string, include?: string[]): Promise<TemplateTag>;
+/**
+ * Create a new template tag
+ *
+ * @param tag Template tag's data
+ *
+ * @returns Created template tag's info
+ */
+declare function createTemplateTag(tag: InputTemplateTag): Promise<TemplateTag>;
+/**
+ * Update or create a template tag
+ *
+ * @param tag Template tag's data **with id**
+ *
+ * @returns Updated/Created template tag's info
+ */
+declare function upsertTemplateTag({
+  id,
+  ...tag
+}: InputTemplateTag & {
+  id: string;
+}): Promise<TemplateTag>;
+/**
+ * Delete a template tag
+ *
+ * @param tagOrId Template tag or template tag's id
+ *
+ * @returns Whether the template tag was deleted
+ */
+declare function deleteTemplateTag(tagOrId: TemplateTag | string): Promise<boolean>;
+//#endregion
+export { upsertTemplateTag as a, getTemplateTag as i, deleteTemplateTag as n, InputTemplateTag as o, getAllTemplateTags as r, TemplateTag as s, createTemplateTag as t };
+//# sourceMappingURL=index-DIYCM-ZC.d.mts.map

package/dist/index-DIYCM-ZC.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-DIYCM-ZC.d.mts","names":[],"sources":["../src/modules/template-tags/types.ts","../src/modules/template-tags/methods.ts"],"sourcesContent":[],"mappings":";;;;;;AAGiB,UAAA,WAAA,CAAW;EAYhB;;;;ECDP;EASiB,KAAA,CAAA,EAAA,MAAA;;;;;AA2BA,KDnCV,gBAAA,GAAmB,ICmCK,CDnCA,WCmCA,EAAA,IAAA,CAAA;;;KApC/B,qBAAA,GAAwB,aAAa;EDXzB,IAAA,EAAA;IAYL,OAAA,EAAA,MAAgB;;;;ACHiC;AAW7D;;;AAEG,iBAFmB,kBAAA,CAEnB,IAyBH,CAzBG,EADM,iBACN,GAAA;EAAO,OAAA,CAAA,EAAA,MAAA,EAAA;AAyBV,CAAA,CAAA,EAzBG,OAyBmB,CAzBX,qBAyByB,CAAA;;;;;AA2BpC;;;AAEG,iBA7BmB,cAAA,CA6BnB,OAAA,EA5BQ,WA4BR,GAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA1BA,OA0BA,CA1BQ,WA0BR,CAAA;;AAoBH;;;;;;AAuBsB,iBA7CA,iBAAA,CA8CX,GAAA,EA7CJ,gBA8CG,CAAA,EA7CP,OA6CO,CA7CC,WA6CD,CAAA;;;;;;;;iBAzBY,iBAAA;;;GAGnB;;IAAoC,QAAQ;;;;;;;;iBAoBzB,iBAAA,UACX,uBACR"}

package/dist/index-DdWYJWZx.d.mts

@@ -0,0 +1,57 @@
+import { n as SdkPaginated, t as ApiRequestOptions } from "./api-CAycTX8Z.mjs";
+import { n as Template, t as InputTemplate } from "./types-D3Or9gzv.mjs";
+
+//#region src/modules/templates/methods.d.ts
+type PaginatedTemplates = SdkPaginated<Omit<Template, 'body'>> & {
+  meta: {
+    default: string;
+  };
+};
+/**
+ * Get all available templates
+ *
+ * @returns All templates' info
+ */
+declare function getAllTemplates(opts?: ApiRequestOptions & {
+  include?: string[];
+}): Promise<PaginatedTemplates>;
+/**
+ * Get template info
+ *
+ * @param templateOrId Template or Template's id
+ *
+ * @returns Template info
+ */
+declare function getTemplate(templateOrId: Omit<Template, 'body'> | string, include?: string[]): Promise<Template>;
+/**
+ * Create a new template
+ *
+ * @param template Template's data
+ *
+ * @returns Created template's info
+ */
+declare function createTemplate(template: InputTemplate): Promise<Template>;
+/**
+ * Update or create a template
+ *
+ * @param template Template's data **with id**
+ *
+ * @returns Updated/Created Template's info
+ */
+declare function upsertTemplate({
+  id,
+  ...template
+}: InputTemplate & {
+  id: string;
+}): Promise<Template>;
+/**
+ * Delete a template
+ *
+ * @param templateOrId Template or Template's id
+ *
+ * @returns Whether the template was deleted
+ */
+declare function deleteTemplate(templateOrId: Omit<Template, 'body'> | string): Promise<boolean>;
+//#endregion
+export { upsertTemplate as a, getTemplate as i, deleteTemplate as n, getAllTemplates as r, createTemplate as t };
+//# sourceMappingURL=index-DdWYJWZx.d.mts.map

package/dist/index-DdWYJWZx.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-DdWYJWZx.d.mts","names":[],"sources":["../src/modules/templates/methods.ts"],"sourcesContent":[],"mappings":";;;;KAeK,kBAAA,GAAqB,aAAa,KAAK;;IAAvC,OAAA,EAAA,MAAA;EAAuC,CAAA;CAAL;;;AASvC;;;AAEG,iBAFmB,eAAA,CAEnB,IA2BH,CA3BG,EADM,iBACN,GAAA;EAAO,OAAA,CAAA,EAAA,MAAA,EAAA;AA2BV,CAAA,CAAA,EA3BG,OA2BmB,CA3BX,kBA2BsB,CAAA;;;;;;AA2BjC;;AAEW,iBA7BW,WAAA,CA6BX,YAAA,EA5BK,IA4BL,CA5BU,QA4BV,EAAA,MAAA,CAAA,GAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA1BR,OA0BQ,CA1BA,QA0BA,CAAA;;;AAoBX;;;;;AAG2C,iBAzBrB,cAAA,CAyBqB,QAAA,EAxB/B,aAwB+B,CAAA,EAvBxC,OAuBwC,CAvBhC,QAuBgC,CAAA;AAoB3C;;;;;;;iBAvBsB,cAAA;;;GAGnB;;IAAiC,QAAQ;;;;;;;;iBAoBtB,cAAA,eACN,KAAK,6BAClB"}

package/dist/index-DwY7Gx4v.d.ts

@@ -0,0 +1,73 @@
+import { n as SdkPaginated, t as ApiRequestOptions } from "./api-Bux99RKM.js";
+
+//#region src/modules/template-tags/types.d.ts
+/**
+ * Tag of a template
+ */
+interface TemplateTag {
+  /** Tag id */
+  id: string;
+  /** Tag name */
+  name: string;
+  /** Tag color. Should be in hex format */
+  color?: string;
+}
+/**
+ * Data needed to create/edit a tag
+ */
+type InputTemplateTag = Omit<TemplateTag, 'id'>;
+//#endregion
+//#region src/modules/template-tags/methods.d.ts
+type PaginatedTemplateTags = SdkPaginated<TemplateTag> & {
+  meta: {
+    default: string;
+  };
+};
+/**
+ * Get all available template tags
+ *
+ * @returns All template tags' info
+ */
+declare function getAllTemplateTags(opts?: ApiRequestOptions & {
+  include?: string[];
+}): Promise<PaginatedTemplateTags>;
+/**
+ * Get template tag info
+ *
+ * @param tagOrId Template tag or template tag's id
+ *
+ * @returns template tag info
+ */
+declare function getTemplateTag(tagOrId: TemplateTag | string, include?: string[]): Promise<TemplateTag>;
+/**
+ * Create a new template tag
+ *
+ * @param tag Template tag's data
+ *
+ * @returns Created template tag's info
+ */
+declare function createTemplateTag(tag: InputTemplateTag): Promise<TemplateTag>;
+/**
+ * Update or create a template tag
+ *
+ * @param tag Template tag's data **with id**
+ *
+ * @returns Updated/Created template tag's info
+ */
+declare function upsertTemplateTag({
+  id,
+  ...tag
+}: InputTemplateTag & {
+  id: string;
+}): Promise<TemplateTag>;
+/**
+ * Delete a template tag
+ *
+ * @param tagOrId Template tag or template tag's id
+ *
+ * @returns Whether the template tag was deleted
+ */
+declare function deleteTemplateTag(tagOrId: TemplateTag | string): Promise<boolean>;
+//#endregion
+export { upsertTemplateTag as a, getTemplateTag as i, deleteTemplateTag as n, InputTemplateTag as o, getAllTemplateTags as r, TemplateTag as s, createTemplateTag as t };
+//# sourceMappingURL=index-DwY7Gx4v.d.ts.map

package/dist/index-DwY7Gx4v.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-DwY7Gx4v.d.ts","names":[],"sources":["../src/modules/template-tags/types.ts","../src/modules/template-tags/methods.ts"],"sourcesContent":[],"mappings":";;;;;;AAGiB,UAAA,WAAA,CAAW;EAYhB;;;;ECDP;EASiB,KAAA,CAAA,EAAA,MAAA;;;;;AA2BA,KDnCV,gBAAA,GAAmB,ICmCK,CDnCA,WCmCA,EAAA,IAAA,CAAA;;;KApC/B,qBAAA,GAAwB,aAAa;EDXzB,IAAA,EAAA;IAYL,OAAA,EAAA,MAAgB;;;;ACHiC;AAW7D;;;AAEG,iBAFmB,kBAAA,CAEnB,IAyBH,CAzBG,EADM,iBACN,GAAA;EAAO,OAAA,CAAA,EAAA,MAAA,EAAA;AAyBV,CAAA,CAAA,EAzBG,OAyBmB,CAzBX,qBAyByB,CAAA;;;;;AA2BpC;;;AAEG,iBA7BmB,cAAA,CA6BnB,OAAA,EA5BQ,WA4BR,GAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA1BA,OA0BA,CA1BQ,WA0BR,CAAA;;AAoBH;;;;;;AAuBsB,iBA7CA,iBAAA,CA8CX,GAAA,EA7CJ,gBA8CG,CAAA,EA7CP,OA6CO,CA7CC,WA6CD,CAAA;;;;;;;;iBAzBY,iBAAA;;;GAGnB;;IAAoC,QAAQ;;;;;;;;iBAoBzB,iBAAA,UACX,uBACR"}

package/dist/index-WThwo4GE.d.mts

@@ -0,0 +1,229 @@
+import { a as TemplateBodyFigure, c as TemplateFilter } from "./types-D3Or9gzv.mjs";
+import { t as FigureAggregation } from "./index-BQMs7hcI.mjs";
+
+//#region src/helpers/templates/editor/figures/utils.d.ts
+/**
+ * Type for orders used in figures, when sorting data
+ * `false` means no sort, `true` means using the default sort
+ */
+type FigureOrder = boolean | 'asc' | 'desc';
+//#endregion
+//#region src/helpers/templates/editor/figures/base.d.ts
+interface FigureHelper {
+  readonly id: string;
+  readonly type: string;
+  params: Record<string, any>;
+  slots: Set<number>;
+  readonly hash: string;
+}
+interface FigureHelperWithData extends FigureHelper {
+  data: string | unknown[];
+}
+interface FigureHelperWithFilters extends FigureHelper {
+  filters: Map<string, TemplateFilter>;
+}
+//#endregion
+//#region src/helpers/templates/editor/figures/md.d.ts
+interface MdFigure extends FigureHelperWithData {
+  readonly type: 'md';
+  data: string;
+  readonly params: Record<string, never>;
+}
+declare function createMdFigureHelper(data?: string, slots?: number[]): MdFigure;
+declare function createMdFigureHelperFrom(figure: TemplateBodyFigure): MdFigure;
+declare function mdHelperParamsToJSON(params: MdFigure['params']): TemplateBodyFigure['params'];
+//#endregion
+//#region src/helpers/templates/editor/figures/metric.d.ts
+/**
+ * Type for labels used in metrics
+ */
+interface MetricLabel {
+  /**
+   * The text of the label (rendered under the value)
+   */
+  text: string;
+  /**
+   * The aggregation used to fetch data,
+   * if not set, the count of documents will be used
+   */
+  aggregation?: FigureAggregation;
+  /**
+   * Format options used to format the data
+   */
+  format?: {
+    type: 'date' | 'number';
+    params?: string[];
+  };
+}
+interface MetricFigureHelper extends FigureHelperWithFilters {
+  readonly type: 'metric';
+  params: {
+    labels: MetricLabel[];
+    order: FigureOrder;
+  };
+}
+declare function createMetricFigureHelper(labels?: MetricLabel[], filters?: TemplateFilter[], order?: FigureOrder, slots?: number[]): MetricFigureHelper;
+declare function createMetricFigureHelperFrom(figure: TemplateBodyFigure): MetricFigureHelper;
+declare function metricHelperParamsToJSON(params: MetricFigureHelper['params']): TemplateBodyFigure['params'];
+declare function getMetricLabelKey(label: MetricLabel): string;
+declare function getAllMetricLabelKeysOfHelper(figure: MetricFigureHelper): string[];
+declare function addMetricLabelOfHelper(figure: MetricFigureHelper, element: MetricLabel, index?: number): MetricFigureHelper;
+declare function removeMetricLabelOfHelper(figure: MetricFigureHelper, element: MetricLabel): MetricFigureHelper;
+declare function updateMetricLabelOfHelper(figure: MetricFigureHelper, oldElement: MetricLabel, newElement: MetricLabel): MetricFigureHelper;
+//#endregion
+//#region src/helpers/templates/editor/figures/table.d.ts
+/**
+ * Type for columns used in tables
+ */
+interface TableColumn {
+  /**
+   * The name of the column
+   */
+  header: string;
+  /**
+   * Whether the column is a metric,
+   * can only be used once in a table
+   */
+  metric?: boolean;
+  /**
+   * The aggregation used to fetch data,
+   * if not set, the "value" of the previous column will be used
+   */
+  aggregation?: FigureAggregation;
+  /**
+   * The style of the cells in this column
+   */
+  styles?: {
+    fontStyle?: 'normal' | 'bold' | 'italic' | 'bolditalic';
+    fillColor?: string | [number, number, number];
+    textColor?: string | [number, number, number];
+    headerColor?: string | [number, number, number];
+    halign?: 'left' | 'center' | 'right' | 'justify';
+    valign?: 'top' | 'middle' | 'bottom';
+    fontSize?: number;
+    lineColor?: string | [number, number, number];
+  };
+}
+/**
+ * Type for tables
+ */
+interface TableFigureHelper extends FigureHelperWithFilters {
+  readonly type: 'table';
+  params: {
+    title: string;
+    columns: TableColumn[];
+    total?: boolean;
+    order?: FigureOrder;
+  };
+}
+declare function createTableFigureHelper(title?: string, columns?: TableColumn[], total?: boolean, filters?: TemplateFilter[], order?: FigureOrder, slots?: number[]): TableFigureHelper;
+declare function createTableFigureHelperFrom(figure: TemplateBodyFigure): TableFigureHelper;
+declare function tableHelperParamsToJSON(params: TableFigureHelper['params']): TemplateBodyFigure['params'];
+declare function getTableColumnKey(column: TableColumn): string;
+declare function getAllTableColumnKeysOfHelper(figure: TableFigureHelper): string[];
+declare function addTableColumnOfHelper(figure: TableFigureHelper, element: TableColumn, index?: number): TableFigureHelper;
+declare function removeTableColumnOfHelper(figure: TableFigureHelper, element: TableColumn): TableFigureHelper;
+declare function updateTableColumnOfHelper(figure: TableFigureHelper, oldElement: TableColumn, newElement: TableColumn): TableFigureHelper;
+//#endregion
+//#region src/helpers/templates/editor/figures/vega.d.ts
+/**
+ * Type for layers used in vega
+ */
+interface VegaLayer extends Record<string, unknown> {
+  /**
+   * The aggregation used to fetch data,
+   * if not set, the "value" of the label (or color if present) layer will be used
+   */
+  aggregation?: FigureAggregation;
+  /**
+   * The title of the axis
+   */
+  title?: string;
+  /**
+   * The legend, if `null` no legend will be shown
+   */
+  legend?: null | {
+    title?: string;
+  };
+}
+/**
+ * Type for data label options
+ */
+interface VegaDataLabelOptions {
+  format: 'percent' | 'numeric';
+  position?: 'out' | 'in';
+  showLabel?: boolean;
+  minValue?: number;
+}
+interface VegaFigureHelper extends FigureHelperWithFilters {
+  params: {
+    /**
+     * The title of the figure
+     */
+    title: string;
+    /**
+     * Whether the axis should be inverted
+     */
+    invertAxis?: boolean;
+    /**
+     * The label layer of the figure, often used for the x axis
+     */
+    label: VegaLayer;
+    /**
+     * The value layer of the figure, often used for the y axis
+     */
+    value: VegaLayer;
+    /**
+     * The color layer of the figure, often used for splitting the value
+     */
+    color?: VegaLayer;
+    /**
+     * The data label options
+     *
+     * Data labels are displayed on top of the value layer, and show details about values
+     */
+    dataLabel?: VegaDataLabelOptions;
+    /**
+     * The order of the data in the chart
+     */
+    order?: FigureOrder;
+  };
+}
+declare function createVegaFigureHelper(type: string, title?: string, label?: VegaLayer, value?: VegaLayer, color?: VegaLayer, dataLabel?: VegaDataLabelOptions, invertAxis?: boolean, filters?: TemplateFilter[], order?: FigureOrder, slots?: number[]): VegaFigureHelper;
+declare function createVegaFigureHelperFrom(figure: TemplateBodyFigure): VegaFigureHelper;
+declare function vegaHelperParamsToJSON(params: VegaFigureHelper['params']): TemplateBodyFigure['params'];
+//#endregion
+//#region src/helpers/templates/editor/figures/index.d.ts
+type AnyFigureHelper = MdFigure | MetricFigureHelper | TableFigureHelper | VegaFigureHelper;
+type FigureHelperSet = Map<string, AnyFigureHelper>;
+/**
+ * Create a figure helper
+ *
+ * @param figure The figure object
+ *
+ * @returns The figure helper
+ */
+declare function createFigureHelper(type: AnyFigureHelper['type'], filters?: TemplateFilter[], order?: FigureOrder, slots?: number[]): AnyFigureHelper;
+/**
+ * Create a figure helper from a figure object
+ *
+ * @param figure The figure object
+ *
+ * @returns The figure helper
+ */
+declare function createFigureHelperFrom(figure: TemplateBodyFigure): AnyFigureHelper;
+/**
+ * Create a figure object from a figure helper
+ *
+ * @param figure The figure helper
+ *
+ * @returns The figure object
+ */
+declare function figureHelperToJSON(figure: AnyFigureHelper): TemplateBodyFigure;
+declare function isFigureHelperMarkdown(figure: AnyFigureHelper): figure is MdFigure;
+declare function isFigureHelperMetric(figure: AnyFigureHelper): figure is MetricFigureHelper;
+declare function isFigureHelperTable(figure: AnyFigureHelper): figure is TableFigureHelper;
+declare function isFigureHelperVega(figure: AnyFigureHelper): figure is VegaFigureHelper;
+//#endregion
+export { createMetricFigureHelperFrom as A, FigureOrder as B, removeTableColumnOfHelper as C, MetricLabel as D, MetricFigureHelper as E, updateMetricLabelOfHelper as F, MdFigure as I, createMdFigureHelper as L, getMetricLabelKey as M, metricHelperParamsToJSON as N, addMetricLabelOfHelper as O, removeMetricLabelOfHelper as P, createMdFigureHelperFrom as R, getTableColumnKey as S, updateTableColumnOfHelper as T, TableFigureHelper as _, figureHelperToJSON as a, createTableFigureHelperFrom as b, isFigureHelperTable as c, VegaFigureHelper as d, VegaLayer as f, TableColumn as g, vegaHelperParamsToJSON as h, createFigureHelperFrom as i, getAllMetricLabelKeysOfHelper as j, createMetricFigureHelper as k, isFigureHelperVega as l, createVegaFigureHelperFrom as m, FigureHelperSet as n, isFigureHelperMarkdown as o, createVegaFigureHelper as p, createFigureHelper as r, isFigureHelperMetric as s, AnyFigureHelper as t, VegaDataLabelOptions as u, addTableColumnOfHelper as v, tableHelperParamsToJSON as w, getAllTableColumnKeysOfHelper as x, createTableFigureHelper as y, mdHelperParamsToJSON as z };
+//# sourceMappingURL=index-WThwo4GE.d.mts.map

package/dist/index-WThwo4GE.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-WThwo4GE.d.mts","names":[],"sources":["../src/helpers/templates/editor/figures/utils.ts","../src/helpers/templates/editor/figures/base.ts","../src/helpers/templates/editor/figures/md.ts","../src/helpers/templates/editor/figures/metric.ts","../src/helpers/templates/editor/figures/table.ts","../src/helpers/templates/editor/figures/vega.ts","../src/helpers/templates/editor/figures/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAIY,KAAA,WAAA,GAAW,OAAA,GAAA,KAAA,GAAA,MAAA;;;UCCb,YAAA;;;EDDE,MAAA,ECKF,MDLa,CAAA,MAAA,EAAA,GAAA,CAAA;SCMd;;;AALC,UAiCO,oBAAA,SAA6B,YA5BlC,CAAA;EA4BK,IAAA,EAAA,MAAA,GAAA,OAAA,EAAqB;AAqBtC;AACW,UADM,uBAAA,SAAgC,YACtC,CAAA;EADsC,OAAA,EACtC,GADsC,CAAA,MAAA,EAC1B,cAD0B,CAAA;;;;UCxDhC,QAAA,SAAiB;;EFCtB,IAAA,EAAA,MAAA;mBEEO;;iBAGH,oBAAA,mCAAmD;ADJzD,iBCQM,wBAAA,CDHJ,MAAA,ECGqC,kBDHrC,CAAA,ECG0D,QDH1D;AA4BK,iBCpBD,oBAAA,CDoB8B,MAAA,ECnBpC,QDmBgD,CAAA,QAAA,CAAA,CAAA,EClBvD,kBDkBuD,CAAA,QAAA,CAAA;;;ADlC1D;;;UGOiB,WAAA;EFNP;AAiCV;AAqBA;EACuB,IAAA,EAAA,MAAA;EAAZ;;;;gBExCK;;ADjBhB;AAMA;EAIgB,MAAA,CAAA,EAAA;IAKA,IAAA,EAAA,MAAA,GAAA,QAAoB;;;;ACPnB,UAmBA,kBAAA,SAA2B,uBAVX,CAAA;EAUhB,SAAA,IAAA,EAAA,QAAmB;EAGxB,MAAA,EAAA;IACD,MAAA,EADC,WACD,EAAA;IAJiC,KAAA,EAIjC,WAJiC;EAAuB,CAAA;AAQnE;AACU,iBADM,wBAAA,CACN,MAAA,CAAA,EAAA,WAAA,EAAA,EAAA,OAAA,CAAA,EACC,cADD,EAAA,EAAA,KAAA,CAAA,EAED,WAFC,EAAA,KAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EAIP,kBAJO;AACC,iBAeK,4BAAA,CAfL,MAAA,EAgBD,kBAhBC,CAAA,EAiBR,kBAjBQ;AACF,iBAyBO,wBAAA,CAzBP,MAAA,EA0BC,kBA1BD,CAAA,QAAA,CAAA,CAAA,EA2BN,kBA3BM,CAAA,QAAA,CAAA;AAEN,iBAgCa,iBAAA,CAhCb,KAAA,EAgCsC,WAhCtC,CAAA,EAAA,MAAA;AAAkB,iBAoCL,6BAAA,CApCK,MAAA,EAqCX,kBArCW,CAAA,EAAA,MAAA,EAAA;AAYL,iBA8BA,sBAAA,CA9B4B,MAClC,EA8BA,kBA7BP,EAAA,OAAA,EA8BQ,WA9BU,EAAA,KAAA,CAAA,EAAA,MAAA,CAAA,EAgClB,kBAhCkB;AASL,iBAgCA,yBAAA,CA/BN,MAAA,EAgCA,kBA/BP,EAAA,OAAkB,EAgCV,WAhCU,CAAA,EAiClB,kBAjCkB;AAOL,iBAmCA,yBAAA,CAnCoC,MAAA,EAoC1C,kBApC0C,EAAA,UAAA,EAqCtC,WArCsC,EAAA,UAAA,EAsCtC,WAtCsC,CAAA,EAuCjD,kBAvCiD;;;AHvEpD;;;UIOiB,WAAA;EHNP;AAiCV;AAqBA;EACuB,MAAA,EAAA,MAAA;EAAZ;;;;;;ACzDX;AAMA;AAIA;EAKgB,WAAA,CAAA,EEOA,iBFPoB;;;;ECPnB,MAAA,CAAA,EAAA;IAmBA,SAAA,CAAA,EAAA,QAAmB,GAAA,MAAA,GAAA,QAAA,GAAA,YAAA;IAGxB,SAAA,CAAA,EAAA,MAAA,GAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA;IACD,SAAA,CAAA,EAAA,MAAA,GAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA;IAJiC,WAAA,CAAA,EAAA,MAAA,GAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA;IAAuB,MAAA,CAAA,EAAA,MAAA,GAAA,QAAA,GAAA,OAAA,GAAA,SAAA;IAQnD,MAAA,CAAA,EAAA,KAAA,GAAA,QAAwB,GAAA,QAAA;IAC9B,QAAA,CAAA,EAAA,MAAA;IACC,SAAA,CAAA,EAAA,MAAA,GAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA;EACF,CAAA;;;AAcT;AAWA;AASgB,UC/BC,iBAAA,SAA0B,uBD+BS,CAAA;EAIpC,SAAA,IAAA,EAAA,OAAA;EAMA,MAAA,EAAA;IACN,KAAA,EAAA,MAAA;IACC,OAAA,ECvCE,WDuCF,EAAA;IAER,KAAA,CAAA,EAAA,OAAA;IAAkB,KAAA,CAAA,ECvCT,WDuCS;EASL,CAAA;;AAEL,iBC9CK,uBAAA,CD8CL,KAAA,CAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EC5CA,WD4CA,EAAA,EAAA,KAAA,CAAA,EAAA,OAAA,EAAA,OAAA,CAAA,EC1CA,cD0CA,EAAA,EAAA,KAAA,CAAA,ECzCF,WDyCE,EAAA,KAAA,CAAA,EAAA,MAAA,EAAA,CAAA,ECvCR,iBDuCQ;AACR,iBC1Ba,2BAAA,CD0Bb,MAAA,ECzBO,kBDyBP,CAAA,ECxBA,iBDwBA;AAAkB,iBCbL,uBAAA,CDaK,MAAA,ECZX,iBDYW,CAAA,QAAA,CAAA,CAAA,ECXlB,kBDWkB,CAAA,QAAA,CAAA;AASL,iBCXA,iBAAA,CDWyB,MAAA,ECXC,WDWD,CAAA,EAAA,MAAA;AAC/B,iBCRM,6BAAA,CDQN,MAAA,ECPA,iBDOA,CAAA,EAAA,MAAA,EAAA;AACI,iBCHE,sBAAA,CDGF,MAAA,ECFJ,iBDEI,EAAA,OAAA,ECDH,WDCG,EAAA,KAAA,CAAA,EAAA,MAAA,CAAA,ECCX,iBDDW;AACA,iBCaE,yBAAA,CDbF,MAAA,ECcJ,iBDdI,EAAA,OAAA,ECeH,WDfG,CAAA,ECgBX,iBDhBW;AACX,iBCwBa,yBAAA,CDxBb,MAAA,ECyBO,iBDzBP,EAAA,UAAA,EC0BW,WD1BX,EAAA,UAAA,EC2BW,WD3BX,CAAA,EC4BA,iBD5BA;;;AH9GH;;;UKOiB,SAAA,SAAkB;EJNzB;AAiCV;AAqBA;;EACW,WAAA,CAAA,EI5CK,iBJ4CL;EADsC;;;;;ACxDjD;AAMA;EAIgB,MAAA,CAAA,EAAA,IAAA,GAAA;IAKA,KAAA,CAAA,EAAA,MAAA;;;;ACPhB;AAmBA;AAGY,UEHK,oBAAA,CFGL;EACD,MAAA,EAAA,SAAA,GAAA,SAAA;EAJiC,QAAA,CAAA,EAAA,KAAA,GAAA,IAAA;EAAuB,SAAA,CAAA,EAAA,OAAA;EAQnD,QAAA,CAAA,EAAA,MAAA;;AAEL,UEHM,gBAAA,SAAyB,uBFG/B,CAAA;EACF,MAAA,EAAA;IAEN;;AAYH;IAWgB,KAAA,EAAA,MAAA;IASA;AAIhB;AAMA;IACU,UAAA,CAAA,EAAA,OAAA;IACC;;;IAWK,KAAA,EEhDL,SFgDK;IACN;;;IAEW,KAAA,EE/CV,SF+CU;IASL;;;IAGF,KAAA,CAAA,EEvDF,SFuDE;IACX;;;;;ICvGc,SAAA,CAAW,ECqDZ,oBDvCA;IAmBC;;;IAA0B,KAAA,CAAA,ECwB/B,WDxB+B;EAAuB,CAAA;AAUlE;AAEW,iBCgBK,sBAAA,CDhBL,IAAA,EAAA,MAAA,EAAA,KAAA,CAAA,EAAA,MAAA,EAAA,KAAA,CAAA,ECmBF,SDnBE,EAAA,KAAA,CAAA,ECoBF,SDpBE,EAAA,KAAA,CAAA,ECqBD,SDrBC,EAAA,SAAA,CAAA,ECsBG,oBDtBH,EAAA,UAAA,CAAA,EAAA,OAAA,EAAA,OAAA,CAAA,ECwBA,cDxBA,EAAA,EAAA,KAAA,CAAA,ECyBF,WDzBE,EAAA,KAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EC2BR,gBD3BQ;AAEA,iBC0CK,0BAAA,CD1CL,MAAA,EC2CD,kBD3CC,CAAA,EC4CR,gBD5CQ;AACF,iBC0DO,sBAAA,CD1DP,MAAA,EC2DC,gBD3DD,CAAA,QAAA,CAAA,CAAA,EC4DN,kBD5DM,CAAA,QAAA,CAAA;;;KE5BG,eAAA,GACR,WACA,qBACA,oBACA;KAEQ,eAAA,GAAkB,YAAY;ALlCoC;AAmC9E;AAqBA;;;;;iBKbgB,kBAAA,OACR,mCACI,0BACF,gCAEP;;;AJhDH;AAMA;AAIA;AAKA;;iBI0EgB,sBAAA,SAA+B,qBAAU;;AHjFzD;AAmBA;;;;;AAQgB,iBG6EA,kBAAA,CH7EwB,MAAA,EG6EG,eH7EH,CAAA,EG6EqB,kBH7ErB;AAC9B,iBG0GM,sBAAA,CH1GN,MAAA,EG2GA,eH3GA,CAAA,EAAA,MAAA,IG4GG,QH5GH;AACC,iBG8GK,oBAAA,CH9GL,MAAA,EG+GD,eH/GC,CAAA,EAAA,MAAA,IGgHE,kBHhHF;AACF,iBGkHO,mBAAA,CHlHP,MAAA,EGmHC,eHnHD,CAAA,EAAA,MAAA,IGoHI,iBHpHJ;AAEN,iBGqHa,kBAAA,CHrHb,MAAA,EGsHO,eHtHP,CAAA,EAAA,MAAA,IGuHU,gBHvHV"}

package/dist/index-ikFTh5Of.d.ts

@@ -0,0 +1,57 @@
+import { n as SdkPaginated, t as ApiRequestOptions } from "./api-Bux99RKM.js";
+import { n as Template, t as InputTemplate } from "./types-C45-jPGm.js";
+
+//#region src/modules/templates/methods.d.ts
+type PaginatedTemplates = SdkPaginated<Omit<Template, 'body'>> & {
+  meta: {
+    default: string;
+  };
+};
+/**
+ * Get all available templates
+ *
+ * @returns All templates' info
+ */
+declare function getAllTemplates(opts?: ApiRequestOptions & {
+  include?: string[];
+}): Promise<PaginatedTemplates>;
+/**
+ * Get template info
+ *
+ * @param templateOrId Template or Template's id
+ *
+ * @returns Template info
+ */
+declare function getTemplate(templateOrId: Omit<Template, 'body'> | string, include?: string[]): Promise<Template>;
+/**
+ * Create a new template
+ *
+ * @param template Template's data
+ *
+ * @returns Created template's info
+ */
+declare function createTemplate(template: InputTemplate): Promise<Template>;
+/**
+ * Update or create a template
+ *
+ * @param template Template's data **with id**
+ *
+ * @returns Updated/Created Template's info
+ */
+declare function upsertTemplate({
+  id,
+  ...template
+}: InputTemplate & {
+  id: string;
+}): Promise<Template>;
+/**
+ * Delete a template
+ *
+ * @param templateOrId Template or Template's id
+ *
+ * @returns Whether the template was deleted
+ */
+declare function deleteTemplate(templateOrId: Omit<Template, 'body'> | string): Promise<boolean>;
+//#endregion
+export { upsertTemplate as a, getTemplate as i, deleteTemplate as n, getAllTemplates as r, createTemplate as t };
+//# sourceMappingURL=index-ikFTh5Of.d.ts.map

package/dist/index-ikFTh5Of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-ikFTh5Of.d.ts","names":[],"sources":["../src/modules/templates/methods.ts"],"sourcesContent":[],"mappings":";;;;KAeK,kBAAA,GAAqB,aAAa,KAAK;;IAAvC,OAAA,EAAA,MAAA;EAAuC,CAAA;CAAL;;;AASvC;;;AAEG,iBAFmB,eAAA,CAEnB,IA2BH,CA3BG,EADM,iBACN,GAAA;EAAO,OAAA,CAAA,EAAA,MAAA,EAAA;AA2BV,CAAA,CAAA,EA3BG,OA2BmB,CA3BX,kBA2BsB,CAAA;;;;;;AA2BjC;;AAEW,iBA7BW,WAAA,CA6BX,YAAA,EA5BK,IA4BL,CA5BU,QA4BV,EAAA,MAAA,CAAA,GAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA1BR,OA0BQ,CA1BA,QA0BA,CAAA;;;AAoBX;;;;;AAG2C,iBAzBrB,cAAA,CAyBqB,QAAA,EAxB/B,aAwB+B,CAAA,EAvBxC,OAuBwC,CAvBhC,QAuBgC,CAAA;AAoB3C;;;;;;;iBAvBsB,cAAA;;;GAGnB;;IAAiC,QAAQ;;;;;;;;iBAoBtB,cAAA,eACN,KAAK,6BAClB"}

package/dist/index-vQuyEowr.d.ts

@@ -0,0 +1,112 @@
+import { n as SdkPaginated, t as ApiRequestOptions } from "./api-Bux99RKM.js";
+import { s as TemplateTag } from "./index-DwY7Gx4v.js";
+import { c as TemplateFilter } from "./types-C45-jPGm.js";
+import { o as TaskRecurrence, r as Task } from "./types-BMxmOgXj.js";
+
+//#region src/modules/task-presets/types.d.ts
+interface TaskPreset {
+  /** Preset ID */
+  id: string;
+  /** Preset name */
+  name: string;
+  /** Template ID */
+  templateId: string;
+  /** Recurrence */
+  recurrence: TaskRecurrence;
+  /** Options used to fetch data for the report */
+  fetchOptions: {
+    /** Default elastic date field to fetch data from */
+    dateField: string;
+    /** Default elastic index to fetch data from */
+    index: string;
+  };
+  /** If preset is hidden */
+  hidden: boolean;
+  /** Preset creation date */
+  createdAt: Date;
+  /** Preset last update date */
+  updatedAt?: Date;
+  /** Template referenced by the preset, must be included when fetching */
+  template?: {
+    /** Template tags */
+    tags?: TemplateTag[];
+    /** If template is hidden */
+    hidden?: boolean;
+  };
+}
+type InputTaskPreset = Omit<TaskPreset, 'id' | 'createdAt' | 'updatedAt' | 'template'>;
+interface AdditionalDataForPreset {
+  /** Task name */
+  name: string;
+  /** Task description */
+  description: string;
+  /** Namespace ID of the task */
+  namespaceId: string;
+  /** Elastic index to fetch data from */
+  index: string;
+  /** Email addresses to send report */
+  targets: string[];
+  /** Global filters used when fetching data */
+  filters?: TemplateFilter[];
+}
+//#endregion
+//#region src/modules/task-presets/methods.d.ts
+type PaginatedTaskPresets = SdkPaginated<TaskPreset>;
+/**
+ * Get all available tasks presets
+ *
+ * @returns All presets' info
+ */
+declare function getAllTaskPresets(opts?: ApiRequestOptions & {
+  include?: string[];
+}): Promise<PaginatedTaskPresets>;
+/**
+ * Get tasks preset info
+ *
+ * @param presetOrId Preset or Preset's id
+ *
+ * @returns Preset info
+ */
+declare function getTaskPreset(presetOrId: TaskPreset | string): Promise<TaskPreset>;
+/**
+ * Create a new tasks preset
+ *
+ * @param preset Preset's data
+ * @param namespaces
+ *
+ * @returns Created preset's info
+ */
+declare function createTaskPreset(preset: InputTaskPreset): Promise<TaskPreset>;
+/**
+ * Update or create a tasks preset
+ *
+ * @param preset Preset's data **with id**
+ *
+ * @returns Updated/Created Preset's info
+ */
+declare function upsertTaskPreset({
+  id,
+  ...preset
+}: InputTaskPreset & {
+  id: string;
+}): Promise<TaskPreset>;
+/**
+ * Delete a tasks preset
+ *
+ * @param presetOrId Preset or Preset's id
+ *
+ * @returns Whether the preset was deleted
+ */
+declare function deleteTaskPreset(presetOrId: TaskPreset | string): Promise<boolean>;
+/**
+ * Create a task from a preset
+ *
+ * @param presetOrId Preset or Preset's id
+ * @param additionalData Additional data for the task
+ *
+ * @returns Created task's info
+ */
+declare function createTaskFromPreset(presetOrId: TaskPreset | string, additionalData: AdditionalDataForPreset): Promise<Task>;
+//#endregion
+export { getTaskPreset as a, InputTaskPreset as c, getAllTaskPresets as i, TaskPreset as l, createTaskPreset as n, upsertTaskPreset as o, deleteTaskPreset as r, AdditionalDataForPreset as s, createTaskFromPreset as t };
+//# sourceMappingURL=index-vQuyEowr.d.ts.map

package/dist/index-vQuyEowr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-vQuyEowr.d.ts","names":[],"sources":["../src/modules/task-presets/types.ts","../src/modules/task-presets/methods.ts"],"sourcesContent":[],"mappings":";;;;;;UAIiB,UAAA;;;EAAA;EAQH,IAAA,EAAA,MAAA;EAWD;EAEC,UAAA,EAAA,MAAA;EAKH;EAAW,UAAA,EAlBR,cAkBQ;EAeV;EAKK,YAAA,EAAA;;;;IC3BZ,KAAA,EAAA,MAAA;EAOiB,CAAA;EACb;EACE,MAAA,EAAA,OAAA;EAAR;EAAO,SAAA,EDTG,ICSH;EA8BY;EACR,SAAA,CAAA,EDtCA,ICsCA;EACH;EAAR,QAAA,CAAA,EAAA;IAAO;IAuBY,IAAA,CAAA,EDzDX,WCyD2B,EAAA;IAC5B;IACC,MAAA,CAAA,EAAA,OAAA;EAAR,CAAA;;AAyEmB,KDrHV,eAAA,GAAkB,ICqHY,CDpHxC,UCoHwC,EAAA,IAAA,GAAA,WAAA,GAAA,WAAA,GAAA,UAAA,CAAA;AAC5B,UDjHG,uBAAA,CCiHH;EACI;EACP,IAAA,EAAA,MAAA;EAAR;EAAO,WAAA,EAAA,MAAA;;;;;;;;YDvGE;;;;KCvCP,oBAAA,GAAuB,aAAa;;;ADnBzC;;;AAqBc,iBCKQ,iBAAA,CDLR,IAKQ,CALR,ECML,iBDNK,GAAA;EAKH,OAAA,CAAA,EAAA,MAAA,EAAA;CAAW,CAAA,ECEnB,ODFmB,CCEX,oBDFW,CAAA;AAetB;AAKA;;;;AC7BiB;AASjB;AACS,iBA+Ba,aAAA,CA/Bb,UAAA,EAgCK,UAhCL,GAAA,MAAA,CAAA,EAiCN,OAjCM,CAiCE,UAjCF,CAAA;;;;AA+BT;;;;;AAyBsB,iBAAA,gBAAA,CAAgB,MAAA,EAC5B,eAD4B,CAAA,EAEnC,OAFmC,CAE3B,UAF2B,CAAA;;;;;AAwBtC;;;AAEW,iBAFW,gBAAA,CAEX;EAAA,EAAA;EAAA,GAAA;CAAA,EADU,eACV,GAAA;EAAR,EAAA,EAAA,MAAA;CAAO,CAAA,EAAP,OAAO,CAAC,UAAD,CAAA;AAsBV;AA2BA;;;;;;iBA3BsB,gBAAA,aACR,sBACX;;;;;;;;;iBAyBmB,oBAAA,aACR,qCACI,0BACf,QAAQ"}