Add Version Detail api endpoint to thunderstore-api

Author: Oksamies

packages/thunderstore-api/src/get/packageVersionDetails.ts

@@ -0,0 +1,24 @@
+import { ApiEndpointProps } from "../index";
+import { apiFetch } from "../apiFetch";
+import { PackageVersionDetailsRequestParams } from "../schemas/requestSchemas";
+import {
+  PackageVersionDetailsResponseData,
+  packageVersionDetailsResponseDataSchema,
+} from "../schemas/responseSchemas";
+
+export async function fetchPackageVersionDetails(
+  props: ApiEndpointProps<PackageVersionDetailsRequestParams, object, object>
+): Promise<PackageVersionDetailsResponseData> {
+  const { config, params } = props;
+  const path = `api/cyberstorm/package/${params.namespace_id}/${params.package_name}/v/${params.package_version}/`;
+
+  return await apiFetch({
+    args: {
+      config: config,
+      path: path,
+    },
+    requestSchema: undefined,
+    queryParamsSchema: undefined,
+    responseSchema: packageVersionDetailsResponseDataSchema,
+  });
+}

packages/thunderstore-api/src/index.ts

@@ -34,6 +34,7 @@ export * from "./get/packageListingDetails";
 export * from "./get/packageReadme";
 export * from "./get/packageSubmission";
 export * from "./get/packageVersions";
+export * from "./get/packageVersionDetails";
 export * from "./get/packageWiki";
 export * from "./get/ratedPackages";
 export * from "./get/teamDetails";

packages/thunderstore-api/src/schemas/objectSchemas.ts

@@ -135,7 +135,7 @@ export const packageListingSchema = z.object({
 
 export type PackageListing = z.infer<typeof packageListingSchema>;
 
-const packageTeamSchema = z.object({
+export const packageTeamSchema = z.object({
   name: z.string().min(1),
   members: teamMemberSchema.array(),
 });

packages/thunderstore-api/src/schemas/requestSchemas.ts

@@ -167,6 +167,17 @@ export type PackageListingDetailsRequestParams = z.infer<
   typeof packageListingDetailsRequestParamsSchema
 >;
 
+// PackageVersionDetailsRequest
+export const packageVersionDetailsRequestParamsSchema = z.object({
+  namespace_id: z.string(),
+  package_name: z.string(),
+  package_version: z.string(),
+});
+
+export type PackageVersionDetailsRequestParams = z.infer<
+  typeof packageVersionDetailsRequestParamsSchema
+>;
+
 // PackageReadmeRequest
 export const packageReadmeRequestParamsSchema = z.object({
   namespace_id: z.string(),

packages/thunderstore-api/src/schemas/responseSchemas.ts

@@ -17,6 +17,7 @@ import {
   markdownRenderSchema,
   packageWikiPageSchema,
   packagePermissionsSchema,
+  packageTeamSchema,
 } from "../schemas/objectSchemas";
 import { paginatedResults } from "../schemas/objectSchemas";
 
@@ -108,6 +109,38 @@ export type PackageListingDetailsResponseData = z.infer<
   typeof packageListingDetailsResponseDataSchema
 >;
 
+// PackageVersionDetailsResponse
+export const packageVersionDetailsResponseDataSchema = z.object({
+  description: z.string(),
+  download_count: z.number().int(),
+  icon_url: z.string().nullable(),
+  name: z.string().min(1),
+  namespace: z.string().min(1),
+  size: z.number().int(),
+  datetime_created: z.string().datetime(),
+  dependencies: z.array(
+    z.object({
+      description: z.string(),
+      icon_url: z.string().nullable(),
+      is_active: z.boolean(),
+      name: z.string().min(1),
+      namespace: z.string().min(1),
+      version_number: z.string().min(1),
+      is_removed: z.boolean(),
+      is_unavailable: z.boolean(),
+    })
+  ),
+  dependency_count: z.number().int(),
+  download_url: z.string(),
+  full_version_name: z.string().min(1),
+  team: packageTeamSchema,
+  website_url: z.string().nullable(),
+});
+
+export type PackageVersionDetailsResponseData = z.infer<
+  typeof packageVersionDetailsResponseDataSchema
+>;
+
 // PackagePermissionsResponse
 export const packagePermissionsResponseDataSchema = packagePermissionsSchema;