Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6da125fe99 | ||
|
|
f82412587d | ||
|
|
36f197aa6d | ||
|
|
05047ee5f7 |
No files matched your search
@@ -202,9 +202,9 @@ Homarr supports multiple authentication options, from internal userbase (credent
|
|||||||
| ``AUTH_OIDC_CLIENT_NAME`` | Display name of provider (in login screen) | OIDC |
|
| ``AUTH_OIDC_CLIENT_NAME`` | Display name of provider (in login screen) | OIDC |
|
||||||
| ``AUTH_OIDC_AUTO_LOGIN`` | Automatically redirect to OIDC login | false |
|
| ``AUTH_OIDC_AUTO_LOGIN`` | Automatically redirect to OIDC login | false |
|
||||||
| ``AUTH_OIDC_SCOPE_OVERWRITE`` | Overwrite default scopes (openid, profile, email) | openid email profile groups |
|
| ``AUTH_OIDC_SCOPE_OVERWRITE`` | Overwrite default scopes (openid, profile, email) | openid email profile groups |
|
||||||
| ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim | groups |
|
| ``AUTH_OIDC_GROUPS_ATTRIBUTE`` | Attribute used for groups (roles) claim. Dot-separated paths such as `resource_access.homarr.roles` are supported. | groups |
|
||||||
| ``AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT`` | Stop syncing group memberships of OIDC users from the groups claim and manage them locally via the group members page instead | false |
|
| ``AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT`` | Stop syncing group memberships of OIDC users from the groups claim and manage them locally via the group members page instead | false |
|
||||||
| ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. By default it will use preferred_username if it does not contain a `@` and otherwise name. | --- |
|
| ``AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE`` | Overwrite name attribute. Dot-separated paths are supported. By default it will use preferred_username if it does not contain a `@` and otherwise name. | --- |
|
||||||
| ``AUTH_OIDC_FORCE_USERINFO`` | Force userinfo endpoint to be used for user information. | false |
|
| ``AUTH_OIDC_FORCE_USERINFO`` | Force userinfo endpoint to be used for user information. | false |
|
||||||
| ``AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING`` | Enable account linking for OIDC provider. This will link the OIDC accounts by email. Be sure that you have verified emails to prevent stealing accounts. | false |
|
| ``AUTH_OIDC_ENABLE_DANGEROUS_ACCOUNT_LINKING`` | Enable account linking for OIDC provider. This will link the OIDC accounts by email. Be sure that you have verified emails to prevent stealing accounts. | false |
|
||||||
| ``AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING`` | Link an OIDC identity to an existing credentials user with the same email. The credentials login and existing user data are preserved. Requires the OIDC profile to contain `email_verified: true`. | false |
|
| ``AUTH_OIDC_ENABLE_DANGEROUS_CREDENTIALS_LINKING`` | Link an OIDC identity to an existing credentials user with the same email. The credentials login and existing user data are preserved. Requires the OIDC profile to contain `email_verified: true`. | false |
|
||||||
|
|||||||
+8
-8
@@ -74,7 +74,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/archiveteam-warrior" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">ArchiveTeam<br/>Warrior</p>
|
<p align="center">ArchiveTeam<br/>Warrior</p>
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/audiobookshelf" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Audiobookshelf</p>
|
<p align="center">Audiobookshelf</p>
|
||||||
@@ -137,7 +137,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/glances" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Glances</p>
|
<p align="center">Glances</p>
|
||||||
@@ -200,7 +200,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/navidrome" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Navidrome</p>
|
<p align="center">Navidrome</p>
|
||||||
@@ -249,7 +249,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/paperless-ngx" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Paperless-ngx</p>
|
<p align="center">Paperless-ngx</p>
|
||||||
@@ -263,7 +263,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/peanut" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">PeaNUT</p>
|
<p align="center">PeaNUT</p>
|
||||||
@@ -313,7 +313,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
|
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@main/png/readarr.png" alt="Readarr" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/readarr.svg" alt="Readarr" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Readarr</p>
|
<p align="center">Readarr</p>
|
||||||
</a>
|
</a>
|
||||||
@@ -424,7 +424,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<a href="https://homarr.dev/docs/integrations/uptime-kuma" target="_blank" rel="noreferrer noopener">
|
<a href="null" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" />
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">Uptime<br/>Kuma</p>
|
<p align="center">Uptime<br/>Kuma</p>
|
||||||
|
|||||||
+5
-10
@@ -9,7 +9,7 @@ import { groupMembers, groups, users } from "@homarr/db/schema";
|
|||||||
import { colorSchemeCookieKey, everyoneGroup } from "@homarr/definitions";
|
import { colorSchemeCookieKey, everyoneGroup } from "@homarr/definitions";
|
||||||
|
|
||||||
import { env } from "./env";
|
import { env } from "./env";
|
||||||
import { extractProfileName } from "./providers/oidc/oidc-provider";
|
import { extractProfileName, getProfileValueByPath } from "./providers/oidc/profile";
|
||||||
|
|
||||||
const logger = createLogger({ module: "authEvents" });
|
const logger = createLogger({ module: "authEvents" });
|
||||||
|
|
||||||
@@ -31,16 +31,11 @@ export const createSignInEventHandler = (db: Database): Exclude<NextAuthConfig["
|
|||||||
if (!dbUser) throw new Error("User not found");
|
if (!dbUser) throw new Error("User not found");
|
||||||
|
|
||||||
const groupsKey = env.AUTH_OIDC_GROUPS_ATTRIBUTE;
|
const groupsKey = env.AUTH_OIDC_GROUPS_ATTRIBUTE;
|
||||||
|
const profileGroups = profile ? getProfileValueByPath(profile, groupsKey) : undefined;
|
||||||
// Groups from oidc provider are provided from the profile, it's not typed.
|
// Groups from oidc provider are provided from the profile, it's not typed.
|
||||||
if (
|
if (!env.AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT && dbUser.provider === "oidc" && Array.isArray(profileGroups)) {
|
||||||
!env.AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT &&
|
logger.debug(`Using profile groups (${groupsKey}): ${JSON.stringify(profileGroups)}`);
|
||||||
dbUser.provider === "oidc" &&
|
await synchronizeGroupsWithExternalForUserAsync(db, user.id, profileGroups as string[]);
|
||||||
profile &&
|
|
||||||
groupsKey in profile &&
|
|
||||||
Array.isArray(profile[groupsKey])
|
|
||||||
) {
|
|
||||||
logger.debug(`Using profile groups (${groupsKey}): ${JSON.stringify(profile[groupsKey])}`);
|
|
||||||
await synchronizeGroupsWithExternalForUserAsync(db, user.id, profile[groupsKey] as string[]);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// In ldap-authroization we return the groups from ldap, it's not typed.
|
// In ldap-authroization we return the groups from ldap, it's not typed.
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/h
|
|||||||
|
|
||||||
import { env } from "../../env";
|
import { env } from "../../env";
|
||||||
import { createRedirectUri } from "../../redirect";
|
import { createRedirectUri } from "../../redirect";
|
||||||
|
import { extractProfileName } from "./profile";
|
||||||
import { assertVerifiedEmailForCredentialsLinking } from "./verified-email";
|
import { assertVerifiedEmailForCredentialsLinking } from "./verified-email";
|
||||||
|
|
||||||
export const OidcProvider = (headers: ReadonlyHeaders | null): OIDCConfig<Profile> => ({
|
export const OidcProvider = (headers: ReadonlyHeaders | null): OIDCConfig<Profile> => ({
|
||||||
@@ -76,12 +77,3 @@ export const OidcProvider = (headers: ReadonlyHeaders | null): OIDCConfig<Profil
|
|||||||
// @ts-expect-error `undici` has a `duplex` option
|
// @ts-expect-error `undici` has a `duplex` option
|
||||||
[customFetch]: fetchWithTrustedCertificatesAsync,
|
[customFetch]: fetchWithTrustedCertificatesAsync,
|
||||||
});
|
});
|
||||||
|
|
||||||
export const extractProfileName = (profile: Profile) => {
|
|
||||||
if (!env.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE) {
|
|
||||||
// Use the name as the username if the preferred_username is an email address
|
|
||||||
return profile.preferred_username?.includes("@") ? profile.name : profile.preferred_username;
|
|
||||||
}
|
|
||||||
|
|
||||||
return profile[env.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE as keyof typeof profile] as string;
|
|
||||||
};
|
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import type { Profile } from "@auth/core/types";
|
||||||
|
|
||||||
|
import { env } from "../../env";
|
||||||
|
|
||||||
|
export const getProfileValueByPath = (profile: Profile, path: string): unknown => {
|
||||||
|
return path.split(".").reduce<unknown>((value, key) => {
|
||||||
|
if (typeof value !== "object" || value === null || !Object.hasOwn(value, key)) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (value as Record<string, unknown>)[key];
|
||||||
|
}, profile);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const extractProfileName = (profile: Profile): string | undefined => {
|
||||||
|
if (!env.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE) {
|
||||||
|
// Use the name as the username if the preferred_username is an email address
|
||||||
|
return (profile.preferred_username?.includes("@") ? profile.name : profile.preferred_username) ?? undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const profileName = getProfileValueByPath(profile, env.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE);
|
||||||
|
return typeof profileName === "string" ? profileName : undefined;
|
||||||
|
};
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
import type { Profile } from "@auth/core/types";
|
||||||
|
import { afterEach, describe, expect, test, vi } from "vitest";
|
||||||
|
|
||||||
|
const mockEnv = vi.hoisted(() => ({
|
||||||
|
AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE: undefined as string | undefined,
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock("../../../env", () => ({ env: mockEnv }));
|
||||||
|
|
||||||
|
import { extractProfileName, getProfileValueByPath } from "../profile";
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
mockEnv.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE = undefined;
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("getProfileValueByPath", () => {
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
resource_access: {
|
||||||
|
homarr: {
|
||||||
|
roles: ["admins"],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
test("returns a top-level claim", () => {
|
||||||
|
expect(getProfileValueByPath(profile, "sub")).toBe("user-id");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns a nested claim", () => {
|
||||||
|
expect(getProfileValueByPath(profile, "resource_access.homarr.roles")).toEqual(["admins"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns undefined when the path does not exist", () => {
|
||||||
|
expect(getProfileValueByPath(profile, "resource_access.missing.roles")).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("extractProfileName", () => {
|
||||||
|
test("uses preferred_username when overwrite is not set", () => {
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
preferred_username: "johndoe",
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBe("johndoe");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("uses name when preferred_username is an email", () => {
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
preferred_username: "john@example.com",
|
||||||
|
name: "John Doe",
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBe("John Doe");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns undefined when the fallback name is null", () => {
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
preferred_username: "john@example.com",
|
||||||
|
name: null,
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns undefined when preferred_username is missing", () => {
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("uses a nested name claim when configured", () => {
|
||||||
|
mockEnv.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE = "user.profile.display_name";
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
user: { profile: { display_name: "Nested User" } },
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBe("Nested User");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("returns undefined when the configured claim is not a string", () => {
|
||||||
|
mockEnv.AUTH_OIDC_NAME_ATTRIBUTE_OVERWRITE = "user.profile";
|
||||||
|
const profile = {
|
||||||
|
sub: "user-id",
|
||||||
|
user: { profile: { display_name: "Nested User" } },
|
||||||
|
} satisfies Profile;
|
||||||
|
|
||||||
|
expect(extractProfileName(profile)).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import type { ResponseCookie } from "next/dist/compiled/@edge-runtime/cookies";
|
import type { ResponseCookie } from "next/dist/compiled/@edge-runtime/cookies";
|
||||||
import type { ReadonlyRequestCookies } from "next/dist/server/web/spec-extension/adapters/request-cookies";
|
import type { ReadonlyRequestCookies } from "next/dist/server/web/spec-extension/adapters/request-cookies";
|
||||||
import { cookies } from "next/headers";
|
import { cookies } from "next/headers";
|
||||||
import { describe, expect, test, vi } from "vitest";
|
import { afterEach, describe, expect, test, vi } from "vitest";
|
||||||
|
|
||||||
import { eq } from "@homarr/db";
|
import { eq } from "@homarr/db";
|
||||||
import type { Database } from "@homarr/db";
|
import type { Database } from "@homarr/db";
|
||||||
@@ -21,6 +21,12 @@ vi.mock("../env", () => {
|
|||||||
env: mockEnv,
|
env: mockEnv,
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
mockEnv.AUTH_OIDC_GROUPS_ATTRIBUTE = "someRandomGroupsKey";
|
||||||
|
mockEnv.AUTH_OIDC_GROUPS_LOCAL_MANAGEMENT = false;
|
||||||
|
});
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
|
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
|
||||||
type HeadersExport = typeof import("next/headers");
|
type HeadersExport = typeof import("next/headers");
|
||||||
vi.mock("next/headers", async (importOriginal) => {
|
vi.mock("next/headers", async (importOriginal) => {
|
||||||
@@ -152,6 +158,30 @@ describe("createSignInEventHandler should create signInEventHandler", () => {
|
|||||||
});
|
});
|
||||||
expect(dbGroupMembers?.groupId).toBe("1");
|
expect(dbGroupMembers?.groupId).toBe("1");
|
||||||
});
|
});
|
||||||
|
test("should add missing group membership from a nested claim", async () => {
|
||||||
|
// Arrange
|
||||||
|
mockEnv.AUTH_OIDC_GROUPS_ATTRIBUTE = "resource_access.homarr.roles";
|
||||||
|
const db = createDb();
|
||||||
|
await createUserAsync(db, "oidc");
|
||||||
|
await createGroupAsync(db);
|
||||||
|
const eventHandler = createSignInEventHandler(db);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await eventHandler?.({
|
||||||
|
user: { id: "1", name: "test" },
|
||||||
|
profile: {
|
||||||
|
preferred_username: "test",
|
||||||
|
resource_access: { homarr: { roles: ["test"] } },
|
||||||
|
},
|
||||||
|
account: null,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
const dbGroupMembers = await db.query.groupMembers.findFirst({
|
||||||
|
where: eq(groupMembers.userId, "1"),
|
||||||
|
});
|
||||||
|
expect(dbGroupMembers?.groupId).toBe("1");
|
||||||
|
});
|
||||||
test("should remove group membership", async () => {
|
test("should remove group membership", async () => {
|
||||||
// Arrange
|
// Arrange
|
||||||
const db = createDb();
|
const db = createDb();
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
import { readFile, writeFile } from "fs/promises";
|
import { readFile, writeFile } from "fs/promises";
|
||||||
import {
|
import { integrationDefs } from "../packages/definitions/src/integration";
|
||||||
getIntegrationDocumentationUrl,
|
|
||||||
integrationDefs,
|
|
||||||
integrationKinds,
|
|
||||||
} from "../packages/definitions/src/integration";
|
|
||||||
|
|
||||||
const FILE = "docs/README.md";
|
const FILE = "docs/README.md";
|
||||||
const MAX_COLUMNS_PER_ROW = 7;
|
const MAX_COLUMNS_PER_ROW = 7;
|
||||||
@@ -25,29 +21,19 @@ async function updateIntegrationList() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Generate the new integration list
|
// Generate the new integration list
|
||||||
const integrations = integrationKinds
|
const integrations = Object.values(integrationDefs)
|
||||||
.filter((kind) => kind !== "mock")
|
.filter((def) => def.name !== "Mock")
|
||||||
.map((kind) => ({
|
.sort((a, b) => a.name.localeCompare(b.name));
|
||||||
...integrationDefs[kind],
|
|
||||||
documentationUrl: getIntegrationDocumentationUrl(kind),
|
|
||||||
}))
|
|
||||||
.toSorted((a, b) => a.name.localeCompare(b.name));
|
|
||||||
const tableRows: string[] = [];
|
const tableRows: string[] = [];
|
||||||
let currentRow: string[] = [];
|
let currentRow: string[] = [];
|
||||||
|
|
||||||
integrations.forEach((integration) => {
|
integrations.forEach((integration) => {
|
||||||
const cellBody = `
|
currentRow.push(`<td align="center">
|
||||||
|
<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">
|
||||||
<img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" />
|
<img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" />
|
||||||
<br/>
|
<br/>
|
||||||
<p align="center">${integration.name.replaceAll(" ", "<br/>")}</p>
|
<p align="center">${integration.name.replaceAll(" ", "<br/>")}</p>
|
||||||
`;
|
</a>
|
||||||
let cellContent = `<div>${cellBody}</div>`;
|
|
||||||
if (integration.documentationUrl !== null) {
|
|
||||||
cellContent = `<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">${cellBody}</a>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
currentRow.push(`<td align="center">
|
|
||||||
${cellContent}
|
|
||||||
</td>`);
|
</td>`);
|
||||||
|
|
||||||
if (currentRow.length === MAX_COLUMNS_PER_ROW) {
|
if (currentRow.length === MAX_COLUMNS_PER_ROW) {
|
||||||
@@ -81,7 +67,4 @@ ${endMarker}`;
|
|||||||
await writeFile(FILE, newContent, "utf8");
|
await writeFile(FILE, newContent, "utf8");
|
||||||
}
|
}
|
||||||
|
|
||||||
updateIntegrationList().catch((error: unknown) => {
|
updateIntegrationList().catch(console.error);
|
||||||
console.error(error);
|
|
||||||
process.exitCode = 1;
|
|
||||||
});
|
|
||||||
Reference in new issue
Block a user