feat: rebuild onboarding experience

packages/docker/src/discovery/parse-container-labels.ts

@@ -0,0 +1,65 @@
+import type { ContainerInfo } from "dockerode";
+
+import { integrationKinds, widgetKinds } from "@homarr/definitions";
+import type { IntegrationKind, WidgetKind } from "@homarr/definitions";
+
+import { dockerLabels, homepageLabels } from "../labels";
+import type { DiscoveredService } from "./types";
+
+export interface ParseContainerLabelsOptions {
+  readHomepageLabels?: boolean;
+}
+
+const integrationKindSet = new Set<string>(integrationKinds);
+const widgetKindSet = new Set<string>(widgetKinds);
+
+const readLabel = (labels: Record<string, string>, key: string) => {
+  const value = labels[key]?.trim();
+  return value ? value : undefined;
+};
+
+const resolveLabelValue = (
+  labels: Record<string, string>,
+  homarrKey: string,
+  homepageKey: string,
+  useHomepageFallback: boolean,
+) => readLabel(labels, homarrKey) ?? (useHomepageFallback ? readLabel(labels, homepageKey) : undefined);
+
+const parseIntegrationKind = (value: string | undefined): IntegrationKind | undefined =>
+  value && integrationKindSet.has(value) ? (value as IntegrationKind) : undefined;
+
+const parseWidgetKind = (value: string | undefined): WidgetKind | undefined =>
+  value && widgetKindSet.has(value) ? (value as WidgetKind) : undefined;
+
+export const parseContainerLabels = (
+  container: Pick<ContainerInfo, "Id" | "Labels">,
+  host: string,
+  options: ParseContainerLabelsOptions = {},
+): DiscoveredService | null => {
+  const labels = container.Labels ?? {};
+  if (dockerLabels.hide in labels) return null;
+
+  const readHomepageLabels = options.readHomepageLabels ?? true;
+  const useHomepageFallback = readHomepageLabels && !readLabel(labels, dockerLabels.name);
+  const name = resolveLabelValue(labels, dockerLabels.name, homepageLabels.name, useHomepageFallback);
+  const href = resolveLabelValue(labels, dockerLabels.href, homepageLabels.href, useHomepageFallback);
+  const group = resolveLabelValue(labels, dockerLabels.group, homepageLabels.group, useHomepageFallback);
+  if (!name || !href) return null;
+
+  const externalId = readLabel(labels, dockerLabels.id) ?? container.Id;
+  return {
+    sourceId: `docker:${host}:${externalId}`,
+    containerId: container.Id,
+    host,
+    group,
+    name,
+    href,
+    icon: resolveLabelValue(labels, dockerLabels.icon, homepageLabels.icon, useHomepageFallback),
+    description: resolveLabelValue(labels, dockerLabels.description, homepageLabels.description, useHomepageFallback),
+    pingUrl: readLabel(labels, dockerLabels.ping),
+    externalId,
+    boardName: readLabel(labels, dockerLabels.board),
+    integrationKind: parseIntegrationKind(readLabel(labels, dockerLabels.integration)),
+    widgetKind: parseWidgetKind(readLabel(labels, dockerLabels.widget)),
+  };
+};