feat(releases-widget): define providers as integrations (#3253)

Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>

packages/integrations/src/interfaces/releases-providers/releases-providers-integration.ts

@@ -0,0 +1,47 @@
+import type {
+  DetailsProviderResponse,
+  ReleaseProviderResponse,
+  ReleasesRepository,
+  ReleasesResponse,
+} from "./releases-providers-types";
+
+export const getLatestRelease = (
+  releases: ReleaseProviderResponse[],
+  repository: ReleasesRepository,
+  details?: DetailsProviderResponse,
+): ReleasesResponse => {
+  const validReleases = releases.filter((result) => {
+    if (result.latestRelease) {
+      return repository.versionRegex ? new RegExp(repository.versionRegex).test(result.latestRelease) : true;
+    }
+
+    return true;
+  });
+
+  const latest =
+    validReleases.length === 0
+      ? ({
+          id: repository.id,
+          error: { code: "noMatchingVersion" },
+        } as ReleasesResponse)
+      : validReleases.reduce(
+          (latest, result) => {
+            return {
+              ...details,
+              ...(result.latestReleaseAt > latest.latestReleaseAt ? result : latest),
+              id: repository.id,
+            };
+          },
+          {
+            id: "",
+            latestRelease: "",
+            latestReleaseAt: new Date(0),
+          },
+        );
+
+  return latest;
+};
+
+export interface ReleasesProviderIntegration {
+  getLatestMatchingReleaseAsync(repository: ReleasesRepository): Promise<ReleasesResponse>;
+}

packages/integrations/src/interfaces/releases-providers/releases-providers-types.ts

@@ -0,0 +1,53 @@
+import type { TranslationObject } from "@homarr/translation";
+
+export interface DetailsProviderResponse {
+  projectUrl?: string;
+  projectDescription?: string;
+  isFork?: boolean;
+  isArchived?: boolean;
+  createdAt?: Date;
+  starsCount?: number;
+  openIssues?: number;
+  forksCount?: number;
+}
+
+export interface ReleaseProviderResponse {
+  latestRelease: string;
+  latestReleaseAt: Date;
+  releaseUrl?: string;
+  releaseDescription?: string;
+  isPreRelease?: boolean;
+}
+
+export interface ReleasesRepository {
+  id: string;
+  identifier: string;
+  versionRegex?: string;
+}
+
+type ReleasesErrorKeys = keyof TranslationObject["widget"]["releases"]["error"]["messages"];
+
+export interface ReleasesResponse {
+  id: string;
+  latestRelease?: string;
+  latestReleaseAt?: Date;
+  releaseUrl?: string;
+  releaseDescription?: string;
+  isPreRelease?: boolean;
+  projectUrl?: string;
+  projectDescription?: string;
+  isFork?: boolean;
+  isArchived?: boolean;
+  createdAt?: Date;
+  starsCount?: number;
+  openIssues?: number;
+  forksCount?: number;
+
+  error?:
+    | {
+        code: ReleasesErrorKeys;
+      }
+    | {
+        message: string;
+      };
+}