Add fetchPackageVersionDependencies function to thunderstore-api

apps/cyberstorm-remix/app/commonComponents/ListingDependency/ListingDependency.tsx

@@ -1,9 +1,9 @@
-import type { packageDependencySchema } from "@thunderstore/thunderstore-api";
+import type { packageListingDependencySchema } from "@thunderstore/thunderstore-api";
 import "./ListingDependency.css";
 import { formatToDisplayName, Image, NewLink } from "@thunderstore/cyberstorm";
 
 export interface ListingDependencyProps {
-  dependency: typeof packageDependencySchema._type;
+  dependency: typeof packageListingDependencySchema._type;
   // TODO: Remove when package versiond detail is available
   domain: string;
 }

packages/dapper-fake/src/fakers/package.ts

@@ -190,6 +190,49 @@ export const getFakePackageVersions = async (
   });
 };
 
+const fakePackageVersionDependencies = range(25).map(() => ({
+  description: faker.company.buzzPhrase(),
+  icon_url: getFakeImg(256, 256),
+  is_active: faker.datatype.boolean(0.5),
+  name: faker.word.words(3).split(" ").join("_"),
+  namespace: faker.word.sample(),
+  version_number: getVersionNumber(),
+  is_removed: faker.datatype.boolean(0.5),
+}));
+
+export const getFakePackageVersionDependencies = async (
+  namespace: string,
+  name: string,
+  version: string,
+  page?: number
+) => {
+  setSeed(`${namespace}-${name}-${version}`);
+  page = page ?? 1;
+
+  // Split the fake data into pages of 10 items each.
+
+  const start = (page - 1) * 10;
+  const end = start + 10;
+  const items = fakePackageVersionDependencies.slice(start, end);
+
+  return {
+    count: fakePackageVersionDependencies.length,
+    next:
+      end < fakePackageVersionDependencies.length
+        ? `https://thunderstore.io/api/cyberstorm/package/${namespace}/${name}/v/${version}/dependencies/?page=${
+            page + 1
+          }`
+        : null,
+    previous:
+      page > 1
+        ? `https://thunderstore.io/api/cyberstorm/package/${namespace}/${name}/v/${version}/dependencies/?page=${
+            page - 1
+          }`
+        : null,
+    results: items,
+  };
+};
+
 const getVersionNumber = (min = 0, max = 10) => {
   const major = faker.number.int({ min, max });
   const minor = faker.number.int({ min, max });

packages/dapper-fake/src/index.ts

@@ -10,6 +10,7 @@ import {
   getFakePackageListingDetails,
   getFakePackageListings,
   getFakePackagePermissions,
+  getFakePackageVersionDependencies,
   getFakePackageVersions,
   getFakePackageSource,
 } from "./fakers/package";
@@ -35,6 +36,7 @@ export class DapperFake implements DapperInterface {
   public getPackageReadme = getFakeReadme;
   public getPackageVersions = getFakePackageVersions;
   public getPackageSource = getFakePackageSource;
+  public getPackageVersionDependencies = getFakePackageVersionDependencies;
   public getTeamDetails = getFakeTeamDetails;
   public getTeamMembers = getFakeTeamMembers;
   public getTeamServiceAccounts = getFakeServiceAccounts;

packages/dapper-ts/src/__tests__/index.test.ts

@@ -4,6 +4,7 @@ import { DapperTs } from "../index";
 const communityId = "test-community-1";
 const namespaceId = "Test_Team_0";
 const packageName = "Test_Package_0";
+const packageVersion = "1.0.0";
 let dapper: DapperTs;
 
 beforeAll(() => {
@@ -37,6 +38,17 @@ it("executes getPackageChangelog without errors", async () => {
   ).resolves.not.toThrowError();
 });
 
+// TODO: Disabled temporarily until we decide on a testing strategy/policy regarding e2e tests
+test.skip("executes getPackageVersionDependencies without errors", async () => {
+  await expect(
+    dapper.getPackageVersionDependencies(
+      namespaceId,
+      packageName,
+      packageVersion
+    )
+  ).resolves.not.toThrowError();
+});
+
 it("executes getPackageListingDetails without errors", async () => {
   await expect(
     dapper.getPackageListingDetails(communityId, namespaceId, packageName)

packages/dapper-ts/src/index.ts

@@ -16,6 +16,7 @@ import {
   getPackageWikiPage,
   getPackagePermissions,
   getPackageSource,
+  getPackageVersionDependencies,
 } from "./methods/package";
 import {
   getPackageListingDetails,
@@ -51,6 +52,8 @@ export class DapperTs implements DapperTsInterface {
     this.getPackageListingDetails = this.getPackageListingDetails.bind(this);
     this.getPackageReadme = this.getPackageReadme.bind(this);
     this.getPackageVersions = this.getPackageVersions.bind(this);
+    this.getPackageVersionDependencies =
+      this.getPackageVersionDependencies.bind(this);
     this.getPackageWiki = this.getPackageWiki.bind(this);
     this.getPackageWikiPage = this.getPackageWikiPage.bind(this);
     this.getPackagePermissions = this.getPackagePermissions.bind(this);
@@ -76,6 +79,7 @@ export class DapperTs implements DapperTsInterface {
   public getPackageListingDetails = getPackageListingDetails;
   public getPackageReadme = getPackageReadme;
   public getPackageVersions = getPackageVersions;
+  public getPackageVersionDependencies = getPackageVersionDependencies;
   public getPackageWiki = getPackageWiki;
   public getPackageWikiPage = getPackageWikiPage;
   public getPackagePermissions = getPackagePermissions;

packages/dapper-ts/src/methods/package.ts

@@ -9,6 +9,8 @@ import {
   fetchPackagePermissions,
   fetchPackageSource,
   ApiError,
+  fetchPackageVersionDependencies,
+  PackageVersionDependenciesRequestQueryParams,
 } from "@thunderstore/thunderstore-api";
 import { z } from "zod";
 
@@ -101,6 +103,34 @@ export async function getPackageVersions(
 
   return data;
 }
+export async function getPackageVersionDependencies(
+  this: DapperTsInterface,
+  namespaceId: string,
+  packageName: string,
+  versionNumber: string,
+  page?: number
+) {
+  const options: PackageVersionDependenciesRequestQueryParams = [
+    {
+      key: "page",
+      value: page,
+      impotent: 1,
+    },
+  ];
+
+  const data = await fetchPackageVersionDependencies({
+    config: this.config,
+    params: {
+      namespace_id: namespaceId,
+      package_name: packageName,
+      version_number: versionNumber,
+    },
+    data: {},
+    queryParams: options,
+  });
+
+  return data;
+}
 
 export async function getPackageWiki(
   this: DapperTsInterface,

packages/dapper/src/dapper.ts

@@ -10,6 +10,7 @@ export interface DapperInterface {
   getPackageListings: methods.GetPackageListings;
   getPackageReadme: methods.GetPackageReadme;
   getPackageVersions: methods.GetPackageVersions;
+  getPackageVersionDependencies: methods.GetPackageVersionDependencies;
   getPackagePermissions: methods.GetPackagePermissions;
   getPackageSource: methods.GetPackageSource;
   getTeamDetails: methods.GetTeamDetails;

packages/dapper/src/types/methods.ts

@@ -10,6 +10,7 @@ import {
   type PackageSource,
   type PackageSubmissionResponse,
   type PackageVersion,
+  type PackageVersionDependencies,
 } from "./package";
 import { type PackageListingType } from "./props";
 import { type HTMLContentResponse, type MarkdownResponse } from "./shared";
@@ -65,6 +66,13 @@ export type GetPackageVersions = (
   name: string
 ) => Promise<PackageVersion[]>;
 
+export type GetPackageVersionDependencies = (
+  namespace: string,
+  name: string,
+  version: string,
+  page?: number
+) => Promise<PackageVersionDependencies>;
+
 export type GetPackagePermissions = (
   namespaceId: string,
   communityId: string,

packages/dapper/src/types/package.ts

@@ -23,7 +23,7 @@ export interface PackageListingDetails extends PackageListing {
   community_name: string;
   datetime_created: string;
   dependant_count: number;
-  dependencies: PackageDependency[];
+  dependencies: PackageListingDependency[];
   dependency_count: number;
   download_url: string;
   full_version_name: string;
@@ -34,7 +34,7 @@ export interface PackageListingDetails extends PackageListing {
   website_url: string | null;
 }
 
-export interface PackageDependency {
+export interface PackageListingDependency {
   community_identifier: string;
   description: string;
   icon_url: string | null;
@@ -57,6 +57,23 @@ export interface PackageVersion {
   install_url: string;
 }
 
+export interface PackageVersionDependency {
+  description: string;
+  icon_url: string;
+  is_active: boolean;
+  name: string;
+  namespace: string;
+  version_number: string;
+  is_removed: boolean;
+}
+
+export type PackageVersionDependencies = {
+  count: number;
+  previous: string | null;
+  next: string | null;
+  results: PackageVersionDependency[];
+};
+
 export interface PackagePermissions {
   package: {
     community_id: string;

packages/thunderstore-api/src/__tests__/defaultConfig.ts

@@ -12,4 +12,5 @@ export const testData = {
   communityId: "test-community-1",
   namespaceId: "Test_Team_0",
   packageName: "Test_Package_0",
+  versionNumber: "1.0.0",
 };

packages/thunderstore-api/src/get/__tests__/packageVersionDependencies.test.ts

@@ -0,0 +1,25 @@
+import { expect, test } from "vitest";
+import { config, testData } from "../../__tests__/defaultConfig";
+import { fetchPackageVersionDependencies } from "../packageVersionDependencies";
+import { packageVersionDependenciesResponseDataSchema } from "../..";
+
+// TODO: Disabled temporarily until we decide on a testing strategy/policy regarding e2e tests
+test.skip("ensures package version dependencies can be fetched", async () => {
+  const { namespaceId, packageName, versionNumber } = testData;
+  const response = await fetchPackageVersionDependencies({
+    config,
+    params: {
+      namespace_id: namespaceId,
+      package_name: packageName,
+      version_number: versionNumber,
+    },
+    data: {},
+    queryParams: [{ key: "page", value: 1, impotent: 1 }],
+  });
+
+  expect(response.count).toBe(3);
+  expect(response.results.length).toBe(3);
+  expect(packageVersionDependenciesResponseDataSchema.parse(response)).toEqual(
+    response
+  );
+});

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

@@ -0,0 +1,35 @@
+import {
+  ApiEndpointProps,
+  packageVersionDependenciesRequestQueryParamsSchema,
+  PackageVersionDependenciesRequestQueryParams,
+  PackageVersionDependenciesRequestParams,
+  packageVersionDependenciesResponseDataSchema,
+  PackageVersionDependenciesResponseData,
+} from "../index";
+import { apiFetch } from "../apiFetch";
+
+export async function fetchPackageVersionDependencies(
+  props: ApiEndpointProps<
+    PackageVersionDependenciesRequestParams,
+    PackageVersionDependenciesRequestQueryParams,
+    object
+  >
+): Promise<PackageVersionDependenciesResponseData> {
+  const {
+    config,
+    params,
+    queryParams = [{ key: "page", value: 1, impotent: 1 }],
+  } = props;
+  const path = `api/cyberstorm/package/${params.namespace_id}/${params.package_name}/v/${params.version_number}/dependencies/`;
+
+  return await apiFetch({
+    args: {
+      config,
+      path,
+      queryParams,
+    },
+    requestSchema: undefined,
+    queryParamsSchema: packageVersionDependenciesRequestQueryParamsSchema,
+    responseSchema: packageVersionDependenciesResponseDataSchema,
+  });
+}

packages/thunderstore-api/src/index.ts

@@ -33,6 +33,7 @@ export * from "./get/packageDependantsListings";
 export * from "./get/packageListingDetails";
 export * from "./get/packageReadme";
 export * from "./get/packageSubmission";
+export * from "./get/packageVersionDependencies";
 export * from "./get/packageVersions";
 export * from "./get/packageWiki";
 export * from "./get/ratedPackages";

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

@@ -142,7 +142,7 @@ const packageTeamSchema = z.object({
 
 export type PackageTeam = z.infer<typeof packageTeamSchema>;
 
-export const packageDependencySchema = z.object({
+export const packageListingDependencySchema = z.object({
   community_identifier: z.string().min(1),
   description: z.string(),
   icon_url: z.string().nullable(),
@@ -152,13 +152,15 @@ export const packageDependencySchema = z.object({
   version_number: z.string().min(1),
 });
 
-export type PackageDependency = z.infer<typeof packageDependencySchema>;
+export type PackageListingDependency = z.infer<
+  typeof packageListingDependencySchema
+>;
 
 export const packageListingDetailsSchema = packageListingSchema.extend({
   community_name: z.string().min(1),
   datetime_created: z.string().datetime(),
   dependant_count: z.number().int(),
-  dependencies: z.array(packageDependencySchema),
+  dependencies: z.array(packageListingDependencySchema),
   dependency_count: z.number().int(),
   download_url: z.string(),
   full_version_name: z.string().min(1),
@@ -244,6 +246,20 @@ export const packageVersionExperimentalSchema = z.object({
   is_active: z.boolean(),
 });
 
+export const packageVersionDependencySchema = z.object({
+  description: z.string(),
+  icon_url: z.string(),
+  is_active: z.boolean(),
+  name: z.string().min(1),
+  namespace: z.string().min(1),
+  version_number: z.string().min(1),
+  is_removed: z.boolean(),
+});
+
+export type PackageVersionDependency = z.infer<
+  typeof packageVersionDependencySchema
+>;
+
 export type PackageVersionExperimental = z.infer<
   typeof packageVersionExperimentalSchema
 >;

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

@@ -188,6 +188,24 @@ export type PackageVersionsRequestParams = z.infer<
   typeof packageVersionsRequestParamsSchema
 >;
 
+// PackageVersionDependenciesRequest
+export const packageVersionDependenciesRequestParamsSchema = z.object({
+  namespace_id: z.string(),
+  package_name: z.string(),
+  version_number: z.string(),
+});
+
+export type PackageVersionDependenciesRequestParams = z.infer<
+  typeof packageVersionDependenciesRequestParamsSchema
+>;
+
+export const packageVersionDependenciesRequestQueryParamsSchema =
+  z.array(pageQueryParam);
+
+export type PackageVersionDependenciesRequestQueryParams = z.infer<
+  typeof packageVersionDependenciesRequestQueryParamsSchema
+>;
+
 // PackageWikiRequest
 export const packageWikiRequestParamsSchema = z.object({
   namespace_id: z.string(),