@sanity/ailf-studio 1.18.0 → 1.19.0

package/dist/index.d.ts

@@ -1212,11 +1212,16 @@ declare const webhookConfigSchema: {
  * Defines URL-based routing so each view is bookmarkable and
  * supports browser back/forward navigation.
  *
- * Route structure:
- *   /ailf                        → Latest Reports (home)
- *   /ailf/report/:reportId       → Report Detail
- *   /ailf/timeline               → Score Timeline
- *   /ailf/compare                → Compare
+ * Route structure (URLs shown with the default tool name `dashboard`;
+ * override via `ailfTool({ name })` to change the segment):
+ *   /dashboard                        → Latest Reports (home)
+ *   /dashboard/report/:reportId       → Report Detail
+ *   /dashboard/timeline               → Score Timeline
+ *
+ * The Compare view (`/dashboard/compare`) is temporarily hidden from
+ * the dashboard tab UI pending more implementation. The router still
+ * accepts `view: "compare"` so any existing bookmarks degrade
+ * gracefully to the Latest Reports tab.
  */
 
 /**
@@ -1238,6 +1243,24 @@ interface AilfToolOptions {
 }
 declare function ailfTool(options?: AilfToolOptions): Tool;
 
+/**
+ * Options for `ailfPlugin()`.
+ */
+interface AilfPluginOptions {
+    /**
+     * Override the AILF dashboard tool's `name` (the URL segment inside
+     * the workspace). Defaults to `"dashboard"`, which avoids URL
+     * collisions with the conventional `ailf` workspace `basePath` —
+     * a workspace at `basePath: "/ailf"` yields the dashboard URL
+     * `/ailf/dashboard` out of the box.
+     *
+     * Set this only when a deployment needs a different label (e.g. a
+     * legacy URL needs to remain stable). The tool segment itself is
+     * mandatory in Sanity Studio's router — this option just relabels
+     * it.
+     */
+    toolName?: string;
+}
 /**
  * AILF Studio plugin — registers the report schema, dashboard tool,
  * and document actions for `ailf.task` documents (Graduate to Native
@@ -1246,6 +1269,6 @@ declare function ailfTool(options?: AilfToolOptions): Tool;
  * This is the recommended way to install the plugin. It registers
  * schemas, the dashboard tool, and document-level actions in one call.
  */
-declare const ailfPlugin: sanity.Plugin<void>;
+declare const ailfPlugin: sanity.Plugin<void | AilfPluginOptions>;
 
-export { ArchiveTaskAction, AssertionInput, CanonicalDocInput, type ComparisonData, type ContentImpactItem, GLOSSARY, GraduateToNativeAction, HelpDrawer, HelpProvider, type HelpTopic, MirrorBanner, type PerModelData, type ProvenanceData, ReleasePicker, type ReportDetail, type ReportListItem, RestoreTaskAction, type RunEvaluationActionOptions, RunTaskEvaluationAction, type ScoreItem, type SummaryData, SyncStatusBadge, type TimelineDataPoint, ailfPlugin, ailfStructure, ailfTaskStructureItem, ailfTool, articleSearchQuery, comparisonPairQuery, contentImpactQuery, createRunEvaluationAction, deriveHelpTopic, distinctAreasQuery, distinctModesQuery, distinctPerspectivesQuery, distinctSourcesQuery, distinctTargetDocumentsQuery, distinctTriggersQuery, evalRequestSchema, featureAreaSchema, findTopic, latestReportsQuery, recentDocumentEvalsQuery, referenceSolutionSchema, reportDetailQuery, reportSchema, scoreTimelineQuery, searchTopics, taskSchema, useHelp, webhookConfigSchema };
+export { type AilfPluginOptions, ArchiveTaskAction, AssertionInput, CanonicalDocInput, type ComparisonData, type ContentImpactItem, GLOSSARY, GraduateToNativeAction, HelpDrawer, HelpProvider, type HelpTopic, MirrorBanner, type PerModelData, type ProvenanceData, ReleasePicker, type ReportDetail, type ReportListItem, RestoreTaskAction, type RunEvaluationActionOptions, RunTaskEvaluationAction, type ScoreItem, type SummaryData, SyncStatusBadge, type TimelineDataPoint, ailfPlugin, ailfStructure, ailfTaskStructureItem, ailfTool, articleSearchQuery, comparisonPairQuery, contentImpactQuery, createRunEvaluationAction, deriveHelpTopic, distinctAreasQuery, distinctModesQuery, distinctPerspectivesQuery, distinctSourcesQuery, distinctTargetDocumentsQuery, distinctTriggersQuery, evalRequestSchema, featureAreaSchema, findTopic, latestReportsQuery, recentDocumentEvalsQuery, referenceSolutionSchema, reportDetailQuery, reportSchema, scoreTimelineQuery, searchTopics, taskSchema, useHelp, webhookConfigSchema };