add new tagCounts endpoint without top-level array type, restore but

deprecate previous `tags` endpoint, swap frontend to use new endpoint

Author: emma-sg

backend/btrixcloud/crawlconfigs.py

@@ -26,7 +26,7 @@
     CrawlConfig,
     CrawlConfigOut,
     CrawlConfigProfileOut,
-    CrawlConfigTagCount,
+    CrawlConfigTags,
     CrawlOut,
     UpdateCrawlConfig,
     Organization,
@@ -977,6 +977,10 @@ async def remove_collection_from_all_configs(
         )
 
     async def get_crawl_config_tags(self, org):
+        """get distinct tags from all crawl configs for this org"""
+        return await self.crawl_configs.distinct("tags", {"oid": org.id})
+
+    async def get_crawl_config_tag_counts(self, org):
         """get distinct tags from all crawl configs for this org"""
         tags = await self.crawl_configs.aggregate(
             [
@@ -1409,10 +1413,17 @@ async def get_crawl_configs(
         )
         return paginated_format(crawl_configs, total, page, pageSize)
 
-    @router.get("/tags", response_model=List[CrawlConfigTagCount])
+    @router.get("/tags", response_model=List[str], deprecated=True)
     async def get_crawl_config_tags(org: Organization = Depends(org_viewer_dep)):
+        '''
+        Deprecated - prefer /api/orgs/{oid}/crawlconfigs/tagCounts instead.
+        '''
         return await ops.get_crawl_config_tags(org)
 
+    @router.get("/tagCounts", response_model=CrawlConfigTags)
+    async def get_crawl_config_tag_counts(org: Organization = Depends(org_viewer_dep)):
+        return {"tags": await ops.get_crawl_config_tag_counts(org)}
+
     @router.get("/search-values", response_model=CrawlConfigSearchValues)
     async def get_crawl_config_search_values(
         org: Organization = Depends(org_viewer_dep),

backend/btrixcloud/models.py

@@ -584,6 +584,12 @@ class CrawlConfigTagCount(BaseModel):
     tag: str
     count: int
 
+# ============================================================================
+class CrawlConfigTags(BaseModel):
+    """Response model for crawlconfig tags"""
+
+    tags: List[CrawlConfigTagCount]
+
 
 # ============================================================================
 class CrawlConfigSearchValues(BaseModel):

frontend/src/components/ui/tag-input.ts

@@ -17,7 +17,7 @@ import { customElement, property, query, state } from "lit/decorators.js";
 import debounce from "lodash/fp/debounce";
 
 import type { UnderlyingFunction } from "@/types/utils";
-import { type WorkflowTags } from "@/types/workflow";
+import { type WorkflowTag } from "@/types/workflow";
 import { dropdown } from "@/utils/css";
 
 export type Tags = string[];
@@ -117,7 +117,7 @@ export class TagInput extends LitElement {
   initialTags?: Tags;
 
   @property({ type: Array })
-  tagOptions: WorkflowTags = [];
+  tagOptions: WorkflowTag[] = [];
 
   @property({ type: Boolean })
   disabled = false;

frontend/src/features/archived-items/file-uploader.ts

@@ -71,7 +71,7 @@ export class FileUploader extends BtrixElement {
   private collectionIds: string[] = [];
 
   @state()
-  private tagOptions: WorkflowTags = [];
+  private tagOptions: WorkflowTag[] = [];
 
   @state()
   private tagsToSave: Tags = [];
@@ -363,8 +363,8 @@ export class FileUploader extends BtrixElement {
 
   private async fetchTags() {
     try {
-      const tags = await this.api.fetch<WorkflowTags>(
-        `/orgs/${this.orgId}/crawlconfigs/tags`,
+      const { tags } = await this.api.fetch<WorkflowTags>(
+        `/orgs/${this.orgId}/crawlconfigs/tagCounts`,
       );
 
       // Update search/filter collection

frontend/src/features/archived-items/item-metadata-editor.ts

@@ -47,7 +47,7 @@ export class CrawlMetadataEditor extends LiteElement {
   private includeName = false;
 
   @state()
-  private tagOptions: WorkflowTags = [];
+  private tagOptions: WorkflowTag[] = [];
 
   @state()
   private tagsToSave: Tags = [];
@@ -166,8 +166,8 @@ export class CrawlMetadataEditor extends LiteElement {
   private async fetchTags() {
     if (!this.crawl) return;
     try {
-      const tags = await this.apiFetch<WorkflowTags>(
-        `/orgs/${this.crawl.oid}/crawlconfigs/tags`,
+      const { tags } = await this.apiFetch<WorkflowTags>(
+        `/orgs/${this.crawl.oid}/crawlconfigs/tagCounts`,
       );
 
       // Update search/filter collection

frontend/src/features/crawl-workflows/workflow-editor.ts

@@ -262,7 +262,7 @@ export class WorkflowEditor extends BtrixElement {
   private showCrawlerChannels = false;
 
   @state()
-  private tagOptions: WorkflowTags = [];
+  private tagOptions: WorkflowTag[] = [];
 
   @state()
   private isSubmitting = false;
@@ -2537,8 +2537,8 @@ https://archiveweb.page/images/${"logo.svg"}`}
   private async fetchTags() {
     this.tagOptions = [];
     try {
-      const tags = await this.api.fetch<WorkflowTags>(
-        `/orgs/${this.orgId}/crawlconfigs/tags`,
+      const { tags } = await this.api.fetch<WorkflowTags>(
+        `/orgs/${this.orgId}/crawlconfigs/tagCounts`,
       );
 
       // Update search/filter collection

frontend/src/features/crawl-workflows/workflow-tag-filter.ts

@@ -66,8 +66,8 @@ export class WorkflowTagFilter extends BtrixElement {
 
   private readonly orgTagsTask = new Task(this, {
     task: async () => {
-      const tags = await this.api.fetch<WorkflowTags>(
-        `/orgs/${this.orgId}/crawlconfigs/tags`,
+      const { tags } = await this.api.fetch<WorkflowTags>(
+        `/orgs/${this.orgId}/crawlconfigs/tagCounts`,
       );
 
       this.fuse.setCollection(tags);

frontend/src/types/workflow.ts

@@ -11,4 +11,6 @@ export type WorkflowTag = {
   count: number;
 };
 
-export type WorkflowTags = WorkflowTag[];
+export type WorkflowTags = {
+  tags: WorkflowTag[];
+};