fix: Content pieces API accept ID list

vriteio · Jul 7, 2024 · 517ad0d · 517ad0d
1 parent 8dc418b
commit 517ad0d
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 16 deletions.
diff --git a/packages/backend/src/lib/mongo.ts b/packages/backend/src/lib/mongo.ts
@@ -3,6 +3,9 @@ import { z } from "zod";
 type UnderscoreID<T extends Record<string, any>> = Omit<T, "id"> & { _id: T["id"] };
 
 const zodId = (): z.ZodString => z.string().regex(/^[a-f\d]{24}$/i, "invalid id");
+const zodIdList = (): z.ZodString => {
+  return z.string().regex(/^[a-f\d]{24}(,[a-f\d]{24})*$/i, "invalid id list");
+};
 
-export { zodId };
+export { zodId, zodIdList };
 export type { UnderscoreID };
diff --git a/packages/backend/src/routes/content-pieces/handlers/list.ts b/packages/backend/src/routes/content-pieces/handlers/list.ts
@@ -11,7 +11,7 @@ import {
   getContentVariantsCollection
 } from "#collections";
 import { AuthenticatedContext } from "#lib/middleware";
-import { zodId } from "#lib/mongo";
+import { zodId, zodIdList } from "#lib/mongo";
 import {
   fetchEntryMembers,
   fetchContentPieceTags,
@@ -22,7 +22,7 @@ import { DocJSON, bufferToJSON } from "#lib/content-processing";
 
 const inputSchema = z.object({
   content: z.boolean().describe("Whether to fetch the JSON content").default(false),
-  contentGroupId: zodId()
+  contentGroupId: zodIdList()
     .describe("Comma-separated list of IDs of the content groups which contain the content pieces")
     .optional(),
   variant: zodId()

diff --git a/packages/sdk/javascript/package.json b/packages/sdk/javascript/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@vrite/sdk",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "private": false,
   "description": "JavaScript SDK and API client for Vrite - open-source developer content platform",
   "license": "MIT",

diff --git a/packages/sdk/javascript/src/api/content-pieces.ts b/packages/sdk/javascript/src/api/content-pieces.ts
@@ -139,7 +139,7 @@ interface ContentPiecesEndpoints {
   >(
     input: PaginationParams & {
       content?: IncludeContent;
-      contentGroupId: string;
+      contentGroupId: string | string[];
       tagId?: string;
       slug?: string;
       variant?: string;
@@ -200,19 +200,26 @@ const createContentPiecesEndpoints = (sendRequest: SendRequest): ContentPiecesEn
   list: <
     CustomData extends Record<string, any> = Record<string, any>,
     IncludeContent extends true | false = false
-  >(
-    input: PaginationParams & {
-      content?: IncludeContent;
-      contentGroupId: string;
-      tagId?: string;
-      slug?: string;
-      variant?: string;
-    }
-  ) => {
+  >({
+    contentGroupId,
+    ...input
+  }: PaginationParams & {
+    content?: IncludeContent;
+    contentGroupId: string | string[];
+    tagId?: string;
+    slug?: string;
+    variant?: string;
+  }) => {
     return sendRequest<Array<ContentPieceWithAdditionalData<CustomData, IncludeContent>>>(
       "GET",
       `${basePath}/list`,
-      { params: input }
+      {
+        params: {
+          ...input,
+          contentGroupId:
+            typeof contentGroupId === "string" ? contentGroupId : contentGroupId.join(",")
+        }
+      }
     );
   }
 });

diff --git a/packages/sdk/javascript/src/api/index.ts b/packages/sdk/javascript/src/api/index.ts
@@ -1,6 +1,6 @@
 export { createClient } from "./client";
 export type { Client, SearchResult } from "./client";
-export type { ContentGroup } from "./content-groups";
+export type { ContentGroup, ContentGroupWithSubtree } from "./content-groups";
 export type {
   ContentPiece,
   ContentPieceWithAdditionalData,

diff --git a/packages/sdk/javascript/src/types/index.d.ts b/packages/sdk/javascript/src/types/index.d.ts
@@ -6,6 +6,7 @@ declare module "virtual:vrite/client" {
     BadRequestError,
     Client,
     ContentGroup,
+    ContentGroupWithSubtree,
     ContentPiece,
     ContentPieceWithAdditionalData,
     JSONContent,