@adminforth/dashboard 1.10.0 → 1.11.1

package/custom/skills/adminforth-dashboard/SKILL.md

@@ -22,26 +22,320 @@ Dashboard root, groups, and widgets are different entities.
 
 ## Tool routing
 
+- Get dashboard slugs: dashboard_get_slugs
 - Read dashboard: dashboard_get_config
 - Add group: dashboard_add_dashboard_group
 - Rename group: dashboard_set_dashboard_group_config
 - Add widget slot: dashboard_add_dashboard_widget
-- Configure table widget: dashboard_configure_table_widget
-- Configure KPI card widget: dashboard_configure_kpi_card_widget
-- Configure gauge card widget: dashboard_configure_gauge_card_widget
-- Configure line chart widget: dashboard_configure_line_chart_widget
-- Configure bar chart widget: dashboard_configure_bar_chart_widget
-- Configure stacked bar chart widget: dashboard_configure_stacked_bar_chart_widget
-- Configure pie chart widget: dashboard_configure_pie_chart_widget
-- Configure histogram chart widget: dashboard_configure_histogram_chart_widget
-- Configure funnel chart widget: dashboard_configure_funnel_chart_widget
-- Configure pivot table widget: dashboard_configure_pivot_table_widget
+- Configure widget:
+  - table: dashboard_configure_table_widget
+  - kpi_card: dashboard_configure_kpi_card_widget
+  - gauge_card: dashboard_configure_gauge_card_widget
+  - pivot_table: dashboard_configure_pivot_table_widget
+  - line_chart: dashboard_configure_line_chart_widget
+  - bar_chart: dashboard_configure_bar_chart_widget
+  - stacked_bar_chart: dashboard_configure_stacked_bar_chart_widget
+  - pie_chart: dashboard_configure_pie_chart_widget
+  - histogram_chart: dashboard_configure_histogram_chart_widget
+  - funnel_chart: dashboard_configure_funnel_chart_widget
 - Move/remove widget/group: matching move/remove tool
 - Load widget data: dashboard_get_dashboard_widget_data
 
 If a known dashboard tool schema is missing, call fetch_tool_schema for that exact tool.
 If fetch_tool_schema returns but the intended tool is still not callable, stop and report a tool-routing error. Do not substitute another mutation tool.
 
+## Configure schema examples
+
+These examples show the expected shape only. Do not copy them one-to-one: adapt resource names, fields, aggregations, labels, filters, formats, and calculations to the actual dashboard request and available resource columns.
+
+Important:
+- `config.target` is the widget target, never a resource path.
+- Never use values like `/resource/llm_usage` in `config.target`.
+- Put the data resource in `config.query.resource`, for example `query.resource: "llm_usage"`.
+- For chart widgets, `config.target` is always `chart`; the concrete chart kind is `config.chart.type`.
+- `query.calcs[].calc` is an expression over already selected fields/aliases, not raw SQL. Do not use SQL syntax such as `CASE WHEN`.
+
+Example `dashboard_configure_table_widget` config:
+
+```yaml
+target: table
+label: Recent usage
+size: wide
+table:
+  columns:
+    - field: used_at
+      label: Date
+    - field: model
+      label: Model
+    - field: total_tokens
+      label: Tokens
+      format: integer
+  pagination: true
+  page_size: 20
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+    - field: model
+    - field: total_tokens
+  order_by:
+    - field: used_at
+      direction: desc
+```
+
+Example `dashboard_configure_kpi_card_widget` config:
+
+```yaml
+target: kpi_card
+label: Total spend
+size: medium
+card:
+  title: Total spend
+  value:
+    field: spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - agg: sum
+      field: cost
+      as: spend
+```
+
+Example `dashboard_configure_gauge_card_widget` config:
+
+```yaml
+target: gauge_card
+label: Budget usage
+size: medium
+card:
+  title: Budget usage
+  value:
+    field: spend
+    format: currency
+  progress:
+    value_field: spend
+    target_value: 1000
+    format: percent
+query:
+  resource: llm_usage
+  select:
+    - agg: sum
+      field: cost
+      as: spend
+```
+
+Example `dashboard_configure_pivot_table_widget` config:
+
+```yaml
+target: pivot_table
+label: Spend by model and purpose
+size: wide
+pivot:
+  rows:
+    - field: model
+      label: Model
+  columns:
+    - field: purpose
+      label: Purpose
+  values:
+    - field: spend
+      label: Spend
+      format: currency
+      aggregation: sum
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - field: purpose
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+    - purpose
+```
+
+Example `dashboard_configure_line_chart_widget` config:
+
+```yaml
+target: chart
+label: Daily spend
+size: wide
+chart:
+  type: line
+  x:
+    field: day
+    label: Day
+  y:
+    - field: spend
+      label: Spend
+      format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+      grain: day
+      as: day
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - field: used_at
+      grain: day
+      as: day
+  order_by:
+    - field: day
+      direction: asc
+```
+
+Example `dashboard_configure_bar_chart_widget` config:
+
+```yaml
+target: chart
+label: Spend by model
+size: wide
+chart:
+  type: bar
+  x:
+    field: model
+    label: Model
+  y:
+    field: spend
+    label: Spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+```
+
+Example `dashboard_configure_stacked_bar_chart_widget` config:
+
+```yaml
+target: chart
+label: Daily spend by purpose
+size: wide
+chart:
+  type: stacked_bar
+  x:
+    field: day
+    label: Day
+  y:
+    field: spend
+    label: Spend
+    format: currency
+  series:
+    field: purpose
+    label: Purpose
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+      grain: day
+      as: day
+    - field: purpose
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - field: used_at
+      grain: day
+      as: day
+    - purpose
+  order_by:
+    - field: day
+      direction: asc
+```
+
+Example `dashboard_configure_pie_chart_widget` config:
+
+```yaml
+target: chart
+label: Spend share by model
+size: medium
+chart:
+  type: pie
+  label:
+    field: model
+    label: Model
+  value:
+    field: spend
+    label: Spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+```
+
+Example `dashboard_configure_histogram_chart_widget` config:
+
+```yaml
+target: chart
+label: Request size distribution
+size: wide
+chart:
+  type: histogram
+  x:
+    field: total_tokens
+    label: Tokens
+  y:
+    field: requests
+    label: Requests
+query:
+  resource: llm_usage
+  select:
+    - field: total_tokens
+    - agg: count
+      as: requests
+  bucket:
+    field: total_tokens
+    buckets:
+      - label: Small
+        max: 1000
+      - label: Medium
+        min: 1000
+        max: 10000
+      - label: Large
+        min: 10000
+```
+
+Example `dashboard_configure_funnel_chart_widget` config:
+
+```yaml
+target: chart
+label: Request funnel
+size: wide
+chart:
+  type: funnel
+  label:
+    field: stage
+    label: Stage
+  value:
+    field: count
+    label: Count
+query:
+  resource: llm_usage
+  select:
+    - field: stage
+    - agg: count
+      as: count
+  group_by:
+    - stage
+```
+
+
 ## Group creation guard
 
 Before creating a group, call dashboard_get_config and check existing groups.
@@ -148,6 +442,7 @@ Use target, not type.
 For charts, use target: chart and chart.type for the concrete chart kind.
 Use query, not dataSource.
 Use resource, not resourceId.
+Never use AdminForth routes such as /resource/llm_usage as resource or target values.
 
 ## Query shape rules
 

package/custom/widgets/KpiCardWidget.vue

@@ -124,9 +124,9 @@ const label = computed(() => kpiConfig.value?.subtitle?.field
       .join(': ')
   : kpiConfig.value?.subtitle?.text ?? kpiConfig.value?.title ?? props.widget.label)
 const formattedValue = computed(() => `${kpiConfig.value?.value.prefix ?? ''}${formatValue(value.value, kpiConfig.value?.value.format)}${kpiConfig.value?.value.suffix ?? ''}`)
-const comparisonValue = computed(() => toFiniteNumber(kpiConfig.value?.comparison?.field
-  ? firstRow.value[kpiConfig.value.comparison.field]
-  : undefined))
+const comparisonValue = computed(() => kpiConfig.value?.comparison?.field
+  ? value.value - toFiniteNumber(firstRow.value[kpiConfig.value.comparison.field])
+  : 0)
 const comparison = computed(() => {
   const config = kpiConfig.value?.comparison
 

package/custom/widgets/chart/StackedBarChart.vue

@@ -120,7 +120,7 @@ const { el: rootEl, width: rootWidth } = useElementSize<HTMLDivElement>()
 const { el: svgEl, width: svgWidth, height: svgHeight } = useElementSize<HTMLDivElement>()
 
 const barGap = 10
-const seriesNames = computed(() => Array.from(new Set(props.rows.map((row) => formatChartLabel(row[props.seriesField])))))
+const seriesNames = computed(() => Array.from(new Set(props.rows.map((row) => formatSeriesLabel(row[props.seriesField])))))
 const normalizedSeries = computed(() => seriesNames.value.map((name, index) => ({
   name,
   color: props.colors?.[index] || CHART_COLORS[index % CHART_COLORS.length],
@@ -141,7 +141,7 @@ const groupedRows = computed(() => {
   for (const row of props.rows) {
     const label = formatChartLabel(row[props.xField])
     const item = grouped.get(label) ?? { [props.xField]: label }
-    const seriesName = formatChartLabel(row[props.seriesField])
+    const seriesName = formatSeriesLabel(row[props.seriesField])
 
     item[seriesName] = toFiniteNumber(item[seriesName]) + toFiniteNumber(row[props.yField])
 
@@ -240,4 +240,8 @@ function getBarTooltip(bar: { label: string, total: number, segments: Array<{ na
     ...segmentLines,
   ].join('\n')
 }
+
+function formatSeriesLabel(value: unknown) {
+  return typeof value === 'string' ? value : String(value)
+}
 </script>

package/dist/custom/skills/adminforth-dashboard/SKILL.md

@@ -22,26 +22,320 @@ Dashboard root, groups, and widgets are different entities.
 
 ## Tool routing
 
+- Get dashboard slugs: dashboard_get_slugs
 - Read dashboard: dashboard_get_config
 - Add group: dashboard_add_dashboard_group
 - Rename group: dashboard_set_dashboard_group_config
 - Add widget slot: dashboard_add_dashboard_widget
-- Configure table widget: dashboard_configure_table_widget
-- Configure KPI card widget: dashboard_configure_kpi_card_widget
-- Configure gauge card widget: dashboard_configure_gauge_card_widget
-- Configure line chart widget: dashboard_configure_line_chart_widget
-- Configure bar chart widget: dashboard_configure_bar_chart_widget
-- Configure stacked bar chart widget: dashboard_configure_stacked_bar_chart_widget
-- Configure pie chart widget: dashboard_configure_pie_chart_widget
-- Configure histogram chart widget: dashboard_configure_histogram_chart_widget
-- Configure funnel chart widget: dashboard_configure_funnel_chart_widget
-- Configure pivot table widget: dashboard_configure_pivot_table_widget
+- Configure widget:
+  - table: dashboard_configure_table_widget
+  - kpi_card: dashboard_configure_kpi_card_widget
+  - gauge_card: dashboard_configure_gauge_card_widget
+  - pivot_table: dashboard_configure_pivot_table_widget
+  - line_chart: dashboard_configure_line_chart_widget
+  - bar_chart: dashboard_configure_bar_chart_widget
+  - stacked_bar_chart: dashboard_configure_stacked_bar_chart_widget
+  - pie_chart: dashboard_configure_pie_chart_widget
+  - histogram_chart: dashboard_configure_histogram_chart_widget
+  - funnel_chart: dashboard_configure_funnel_chart_widget
 - Move/remove widget/group: matching move/remove tool
 - Load widget data: dashboard_get_dashboard_widget_data
 
 If a known dashboard tool schema is missing, call fetch_tool_schema for that exact tool.
 If fetch_tool_schema returns but the intended tool is still not callable, stop and report a tool-routing error. Do not substitute another mutation tool.
 
+## Configure schema examples
+
+These examples show the expected shape only. Do not copy them one-to-one: adapt resource names, fields, aggregations, labels, filters, formats, and calculations to the actual dashboard request and available resource columns.
+
+Important:
+- `config.target` is the widget target, never a resource path.
+- Never use values like `/resource/llm_usage` in `config.target`.
+- Put the data resource in `config.query.resource`, for example `query.resource: "llm_usage"`.
+- For chart widgets, `config.target` is always `chart`; the concrete chart kind is `config.chart.type`.
+- `query.calcs[].calc` is an expression over already selected fields/aliases, not raw SQL. Do not use SQL syntax such as `CASE WHEN`.
+
+Example `dashboard_configure_table_widget` config:
+
+```yaml
+target: table
+label: Recent usage
+size: wide
+table:
+  columns:
+    - field: used_at
+      label: Date
+    - field: model
+      label: Model
+    - field: total_tokens
+      label: Tokens
+      format: integer
+  pagination: true
+  page_size: 20
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+    - field: model
+    - field: total_tokens
+  order_by:
+    - field: used_at
+      direction: desc
+```
+
+Example `dashboard_configure_kpi_card_widget` config:
+
+```yaml
+target: kpi_card
+label: Total spend
+size: medium
+card:
+  title: Total spend
+  value:
+    field: spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - agg: sum
+      field: cost
+      as: spend
+```
+
+Example `dashboard_configure_gauge_card_widget` config:
+
+```yaml
+target: gauge_card
+label: Budget usage
+size: medium
+card:
+  title: Budget usage
+  value:
+    field: spend
+    format: currency
+  progress:
+    value_field: spend
+    target_value: 1000
+    format: percent
+query:
+  resource: llm_usage
+  select:
+    - agg: sum
+      field: cost
+      as: spend
+```
+
+Example `dashboard_configure_pivot_table_widget` config:
+
+```yaml
+target: pivot_table
+label: Spend by model and purpose
+size: wide
+pivot:
+  rows:
+    - field: model
+      label: Model
+  columns:
+    - field: purpose
+      label: Purpose
+  values:
+    - field: spend
+      label: Spend
+      format: currency
+      aggregation: sum
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - field: purpose
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+    - purpose
+```
+
+Example `dashboard_configure_line_chart_widget` config:
+
+```yaml
+target: chart
+label: Daily spend
+size: wide
+chart:
+  type: line
+  x:
+    field: day
+    label: Day
+  y:
+    - field: spend
+      label: Spend
+      format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+      grain: day
+      as: day
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - field: used_at
+      grain: day
+      as: day
+  order_by:
+    - field: day
+      direction: asc
+```
+
+Example `dashboard_configure_bar_chart_widget` config:
+
+```yaml
+target: chart
+label: Spend by model
+size: wide
+chart:
+  type: bar
+  x:
+    field: model
+    label: Model
+  y:
+    field: spend
+    label: Spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+```
+
+Example `dashboard_configure_stacked_bar_chart_widget` config:
+
+```yaml
+target: chart
+label: Daily spend by purpose
+size: wide
+chart:
+  type: stacked_bar
+  x:
+    field: day
+    label: Day
+  y:
+    field: spend
+    label: Spend
+    format: currency
+  series:
+    field: purpose
+    label: Purpose
+query:
+  resource: llm_usage
+  select:
+    - field: used_at
+      grain: day
+      as: day
+    - field: purpose
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - field: used_at
+      grain: day
+      as: day
+    - purpose
+  order_by:
+    - field: day
+      direction: asc
+```
+
+Example `dashboard_configure_pie_chart_widget` config:
+
+```yaml
+target: chart
+label: Spend share by model
+size: medium
+chart:
+  type: pie
+  label:
+    field: model
+    label: Model
+  value:
+    field: spend
+    label: Spend
+    format: currency
+query:
+  resource: llm_usage
+  select:
+    - field: model
+    - agg: sum
+      field: cost
+      as: spend
+  group_by:
+    - model
+```
+
+Example `dashboard_configure_histogram_chart_widget` config:
+
+```yaml
+target: chart
+label: Request size distribution
+size: wide
+chart:
+  type: histogram
+  x:
+    field: total_tokens
+    label: Tokens
+  y:
+    field: requests
+    label: Requests
+query:
+  resource: llm_usage
+  select:
+    - field: total_tokens
+    - agg: count
+      as: requests
+  bucket:
+    field: total_tokens
+    buckets:
+      - label: Small
+        max: 1000
+      - label: Medium
+        min: 1000
+        max: 10000
+      - label: Large
+        min: 10000
+```
+
+Example `dashboard_configure_funnel_chart_widget` config:
+
+```yaml
+target: chart
+label: Request funnel
+size: wide
+chart:
+  type: funnel
+  label:
+    field: stage
+    label: Stage
+  value:
+    field: count
+    label: Count
+query:
+  resource: llm_usage
+  select:
+    - field: stage
+    - agg: count
+      as: count
+  group_by:
+    - stage
+```
+
+
 ## Group creation guard
 
 Before creating a group, call dashboard_get_config and check existing groups.
@@ -148,6 +442,7 @@ Use target, not type.
 For charts, use target: chart and chart.type for the concrete chart kind.
 Use query, not dataSource.
 Use resource, not resourceId.
+Never use AdminForth routes such as /resource/llm_usage as resource or target values.
 
 ## Query shape rules
 

package/dist/custom/widgets/KpiCardWidget.vue

@@ -124,9 +124,9 @@ const label = computed(() => kpiConfig.value?.subtitle?.field
       .join(': ')
   : kpiConfig.value?.subtitle?.text ?? kpiConfig.value?.title ?? props.widget.label)
 const formattedValue = computed(() => `${kpiConfig.value?.value.prefix ?? ''}${formatValue(value.value, kpiConfig.value?.value.format)}${kpiConfig.value?.value.suffix ?? ''}`)
-const comparisonValue = computed(() => toFiniteNumber(kpiConfig.value?.comparison?.field
-  ? firstRow.value[kpiConfig.value.comparison.field]
-  : undefined))
+const comparisonValue = computed(() => kpiConfig.value?.comparison?.field
+  ? value.value - toFiniteNumber(firstRow.value[kpiConfig.value.comparison.field])
+  : 0)
 const comparison = computed(() => {
   const config = kpiConfig.value?.comparison
 

package/dist/custom/widgets/chart/StackedBarChart.vue

@@ -120,7 +120,7 @@ const { el: rootEl, width: rootWidth } = useElementSize<HTMLDivElement>()
 const { el: svgEl, width: svgWidth, height: svgHeight } = useElementSize<HTMLDivElement>()
 
 const barGap = 10
-const seriesNames = computed(() => Array.from(new Set(props.rows.map((row) => formatChartLabel(row[props.seriesField])))))
+const seriesNames = computed(() => Array.from(new Set(props.rows.map((row) => formatSeriesLabel(row[props.seriesField])))))
 const normalizedSeries = computed(() => seriesNames.value.map((name, index) => ({
   name,
   color: props.colors?.[index] || CHART_COLORS[index % CHART_COLORS.length],
@@ -141,7 +141,7 @@ const groupedRows = computed(() => {
   for (const row of props.rows) {
     const label = formatChartLabel(row[props.xField])
     const item = grouped.get(label) ?? { [props.xField]: label }
-    const seriesName = formatChartLabel(row[props.seriesField])
+    const seriesName = formatSeriesLabel(row[props.seriesField])
 
     item[seriesName] = toFiniteNumber(item[seriesName]) + toFiniteNumber(row[props.yField])
 
@@ -240,4 +240,8 @@ function getBarTooltip(bar: { label: string, total: number, segments: Array<{ na
     ...segmentLines,
   ].join('\n')
 }
+
+function formatSeriesLabel(value: unknown) {
+  return typeof value === 'string' ? value : String(value)
+}
 </script>

package/dist/endpoint/dashboard.d.ts

@@ -3,6 +3,7 @@ import type { DashboardConfig } from '../custom/model/dashboard.types.js';
 import type { DashboardRecord } from '../services/dashboardConfigService.js';
 type DashboardEndpointsContext = {
     getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
+    getAllDashboardRecords: () => Promise<DashboardRecord[]>;
     parseStoredDashboardConfig: (config: unknown) => DashboardConfig;
 };
 export declare function registerDashboardEndpoints(server: IHttpServer, ctx: DashboardEndpointsContext): void;

package/dist/endpoint/dashboard.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { DashboardApiResponseSchema, SlugRequestSchema, } from '../schema/api.js';
+import { DashboardApiResponseSchema, GetSlugsResponseSchema, SlugRequestSchema, } from '../schema/api.js';
 export function registerDashboardEndpoints(server, ctx) {
     server.endpoint({
         method: 'POST',
@@ -30,4 +30,18 @@ export function registerDashboardEndpoints(server, ctx) {
             };
         }),
     });
+    server.endpoint({
+        method: 'GET',
+        path: '/dashboard/get-slugs',
+        description: 'Returns a list of all dashboard slugs and labels for listing purposes.',
+        request_schema: undefined,
+        response_schema: GetSlugsResponseSchema,
+        handler: () => __awaiter(this, void 0, void 0, function* () {
+            const dashboards = yield ctx.getAllDashboardRecords();
+            return dashboards.map((dashboard) => ({
+                slug: dashboard.slug,
+                label: dashboard.label,
+            }));
+        }),
+    });
 }

package/dist/schema/api.d.ts

@@ -6829,6 +6829,10 @@ export declare const DashboardWidgetDataResponseZodSchema: z.ZodUnion<readonly [
 export declare const SlugRequestZodSchema: z.ZodObject<{
     slug: z.ZodString;
 }, z.core.$strict>;
+export declare const GetSlugsResponseZodSchema: z.ZodArray<z.ZodObject<{
+    slug: z.ZodString;
+    label: z.ZodString;
+}, z.core.$strip>>;
 export declare const GroupIdRequestZodSchema: z.ZodObject<{
     slug: z.ZodString;
     groupId: z.ZodString;
@@ -13563,6 +13567,10 @@ export declare const DashboardWidgetDataResponseSchema: z.core.ZodStandardJSONSc
 export declare const SlugRequestSchema: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
     slug: z.ZodString;
 }, z.core.$strict>>;
+export declare const GetSlugsResponseSchema: z.core.ZodStandardJSONSchemaPayload<z.ZodArray<z.ZodObject<{
+    slug: z.ZodString;
+    label: z.ZodString;
+}, z.core.$strip>>>;
 export declare const GroupIdRequestSchema: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
     slug: z.ZodString;
     groupId: z.ZodString;

package/dist/schema/api.js

@@ -38,6 +38,10 @@ export const DashboardWidgetDataResponseZodSchema = z.union([
 export const SlugRequestZodSchema = z.object({
     slug: z.string(),
 }).strict();
+export const GetSlugsResponseZodSchema = z.array(z.object({
+    slug: z.string(),
+    label: z.string(),
+}));
 export const GroupIdRequestZodSchema = z.object({
     slug: z.string(),
     groupId: z.string(),
@@ -168,6 +172,7 @@ export const DashboardMutationResponseZodSchema = z.object({
 export const DashboardApiResponseSchema = toJSONSchema(z.unknown(), { target: 'draft-07' });
 export const DashboardWidgetDataResponseSchema = toJSONSchema(DashboardWidgetDataResponseZodSchema, { target: 'draft-07' });
 export const SlugRequestSchema = toJSONSchema(SlugRequestZodSchema, { target: 'draft-07' });
+export const GetSlugsResponseSchema = toJSONSchema(GetSlugsResponseZodSchema, { target: 'draft-07' });
 export const GroupIdRequestSchema = toJSONSchema(GroupIdRequestZodSchema, { target: 'draft-07' });
 export const MoveGroupRequestSchema = toJSONSchema(MoveGroupRequestZodSchema, { target: 'draft-07' });
 export const SetGroupConfigRequestSchema = toJSONSchema(SetGroupConfigRequestZodSchema, { target: 'draft-07' });

package/dist/services/dashboardConfigService.d.ts

@@ -17,10 +17,12 @@ export type PersistedDashboardResponse = {
 };
 type DashboardConfigMutator = (config: DashboardConfig, dashboard: DashboardRecord) => DashboardConfig | null | Promise<DashboardConfig | null>;
 export declare function getDashboardRecord(adminforth: IAdminForth, dashboardConfigsResourceId: string, slug: string): Promise<DashboardRecord | null>;
+export declare function getAllDashboardRecords(adminforth: IAdminForth, dashboardConfigsResourceId: string): Promise<DashboardRecord[]>;
 export declare function persistDashboardConfig(adminforth: IAdminForth, dashboardConfigsResourceId: string, dashboard: DashboardRecord, config: DashboardConfig): Promise<PersistedDashboardResponse>;
 export declare function updateDashboardConfig(adminforth: IAdminForth, dashboardConfigsResourceId: string, slug: string, mutateConfig: DashboardConfigMutator): Promise<PersistedDashboardResponse | null>;
 export type DashboardConfigService = {
     getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
+    getAllDashboardRecords: () => Promise<DashboardRecord[]>;
     parseStoredDashboardConfig: typeof parseStoredDashboardConfig;
     persistDashboardConfig: (dashboard: DashboardRecord, config: DashboardConfig) => Promise<PersistedDashboardResponse>;
     updateDashboardConfig: (slug: string, mutateConfig: DashboardConfigMutator) => Promise<PersistedDashboardResponse | null>;

package/dist/services/dashboardConfigService.js

@@ -57,6 +57,11 @@ export function getDashboardRecord(adminforth, dashboardConfigsResourceId, slug)
         return dashboard || null;
     });
 }
+export function getAllDashboardRecords(adminforth, dashboardConfigsResourceId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield adminforth.resource(dashboardConfigsResourceId).list([]);
+    });
+}
 export function persistDashboardConfig(adminforth, dashboardConfigsResourceId, dashboard, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const normalizedConfig = normalizeDashboardOrder(config);
@@ -103,6 +108,7 @@ export function updateDashboardConfig(adminforth, dashboardConfigsResourceId, sl
 export function createDashboardConfigService(adminforth, dashboardConfigsResourceId) {
     return {
         getDashboardRecord: (slug) => getDashboardRecord(adminforth, dashboardConfigsResourceId, slug),
+        getAllDashboardRecords: () => getAllDashboardRecords(adminforth, dashboardConfigsResourceId),
         parseStoredDashboardConfig,
         persistDashboardConfig: (dashboard, config) => persistDashboardConfig(adminforth, dashboardConfigsResourceId, dashboard, config),
         updateDashboardConfig: (slug, mutateConfig) => updateDashboardConfig(adminforth, dashboardConfigsResourceId, slug, mutateConfig),

package/endpoint/dashboard.ts

@@ -2,12 +2,14 @@ import type { IHttpServer } from 'adminforth';
 import type { DashboardConfig } from '../custom/model/dashboard.types.js';
 import {
   DashboardApiResponseSchema,
+  GetSlugsResponseSchema,
   SlugRequestSchema,
 } from '../schema/api.js';
 import type { DashboardRecord } from '../services/dashboardConfigService.js';
 
 type DashboardEndpointsContext = {
   getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
+  getAllDashboardRecords: () => Promise<DashboardRecord[]>;
   parseStoredDashboardConfig: (config: unknown) => DashboardConfig;
 };
 
@@ -38,4 +40,19 @@ export function registerDashboardEndpoints(
       };
     },
   });
+
+  server.endpoint({
+    method: 'GET',
+    path: '/dashboard/get-slugs',
+    description: 'Returns a list of all dashboard slugs and labels for listing purposes.',
+    request_schema: undefined,
+    response_schema: GetSlugsResponseSchema,
+    handler: async () => {
+      const dashboards = await ctx.getAllDashboardRecords();
+      return dashboards.map((dashboard) => ({
+        slug: dashboard.slug,
+        label: dashboard.label,
+      }));
+    },
+  });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/dashboard",
-  "version": "1.10.0",
+  "version": "1.11.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/schema/api.ts

@@ -60,6 +60,11 @@ export const SlugRequestZodSchema = z.object({
   slug: z.string(),
 }).strict()
 
+export const GetSlugsResponseZodSchema = z.array(z.object({
+  slug: z.string(),
+  label: z.string(),
+}))
+
 export const GroupIdRequestZodSchema = z.object({
   slug: z.string(),
   groupId: z.string(),
@@ -213,6 +218,7 @@ export const DashboardMutationResponseZodSchema = z.object({
 export const DashboardApiResponseSchema = toJSONSchema(z.unknown(), { target: 'draft-07' })
 export const DashboardWidgetDataResponseSchema = toJSONSchema(DashboardWidgetDataResponseZodSchema, { target: 'draft-07' })
 export const SlugRequestSchema = toJSONSchema(SlugRequestZodSchema, { target: 'draft-07' })
+export const GetSlugsResponseSchema = toJSONSchema(GetSlugsResponseZodSchema, { target: 'draft-07' })
 export const GroupIdRequestSchema = toJSONSchema(GroupIdRequestZodSchema, { target: 'draft-07' })
 export const MoveGroupRequestSchema = toJSONSchema(MoveGroupRequestZodSchema, { target: 'draft-07' })
 export const SetGroupConfigRequestSchema = toJSONSchema(SetGroupConfigRequestZodSchema, { target: 'draft-07' })

package/services/dashboardConfigService.ts

@@ -96,6 +96,13 @@ export async function getDashboardRecord(
   return dashboard || null;
 }
 
+export async function getAllDashboardRecords(
+  adminforth: IAdminForth,
+  dashboardConfigsResourceId: string,
+): Promise<DashboardRecord[]> {
+  return await adminforth.resource(dashboardConfigsResourceId).list([]);
+}
+
 export async function persistDashboardConfig(
   adminforth: IAdminForth,
   dashboardConfigsResourceId: string,
@@ -156,6 +163,7 @@ export async function updateDashboardConfig(
 
 export type DashboardConfigService = {
   getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
+  getAllDashboardRecords: () => Promise<DashboardRecord[]>;
   parseStoredDashboardConfig: typeof parseStoredDashboardConfig;
   persistDashboardConfig: (
     dashboard: DashboardRecord,
@@ -173,6 +181,7 @@ export function createDashboardConfigService(
 ): DashboardConfigService {
   return {
     getDashboardRecord: (slug) => getDashboardRecord(adminforth, dashboardConfigsResourceId, slug),
+    getAllDashboardRecords: () => getAllDashboardRecords(adminforth, dashboardConfigsResourceId),
     parseStoredDashboardConfig,
     persistDashboardConfig: (dashboard, config) => persistDashboardConfig(
       adminforth,