Add getPackageVersionDependencies to Dapper and DapperFake

Author: Oksamies

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,
 } from "./fakers/package";
 import { getFakeServiceAccounts } from "./fakers/serviceAccount";
@@ -33,6 +34,7 @@ export class DapperFake implements DapperInterface {
   public getPackageListings = getFakePackageListings;
   public getPackageReadme = getFakeReadme;
   public getPackageVersions = getFakePackageVersions;
+  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,16 @@ it("executes getPackageChangelog without errors", async () => {
   ).resolves.not.toThrowError();
 });
 
+it("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

@@ -15,6 +15,7 @@ import {
   getPackageWiki,
   getPackageWikiPage,
   getPackagePermissions,
+  getPackageVersionDependencies,
 } from "./methods/package";
 import {
   getPackageListingDetails,
@@ -50,6 +51,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);
@@ -74,6 +77,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

@@ -8,6 +8,8 @@ import {
   fetchPackageWikiPage,
   fetchPackagePermissions,
   ApiError,
+  fetchPackageVersionDependencies,
+  PackageVersionDependenciesRequestQueryParams,
 } from "@thunderstore/thunderstore-api";
 import { z } from "zod";
 
@@ -80,6 +82,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;
   getTeamDetails: methods.GetTeamDetails;
   getTeamMembers: methods.GetTeamMembers;

packages/dapper/src/types/methods.ts

@@ -9,6 +9,7 @@ import {
   type PackagePermissions,
   type PackageSubmissionResponse,
   type PackageVersion,
+  type PackageVersionDependencies,
 } from "./package";
 import { type PackageListingType } from "./props";
 import { type HTMLContentResponse, type MarkdownResponse } from "./shared";
@@ -64,6 +65,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

@@ -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;