Track HiveGrid Cloud planning reference
This commit is contained in:
1 parent
b3d5ea6764
commit
e341c5938a
5784 files changed
+1104929
-3
No files matched your search
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"name": "@toolctrl/brand",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
".": "./src/index.ts"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "vitest run src",
|
||||
"typecheck": "tsc -p tsconfig.json --noEmit"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^25.6.0",
|
||||
"typescript": "^5.3.2"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import { loadBrandFromEnv } from "./env.js";
|
||||
import { createBrandTokens, defaultBrandTokens } from "./index.js";
|
||||
|
||||
describe("loadBrandFromEnv", () => {
|
||||
it("returns no overrides when env is empty", () => {
|
||||
expect(loadBrandFromEnv({})).toEqual({});
|
||||
});
|
||||
|
||||
it("treats whitespace-only env values as absent", () => {
|
||||
expect(
|
||||
loadBrandFromEnv({
|
||||
BRAND_PRODUCT_NAME: " ",
|
||||
BRAND_SITE_URL: "",
|
||||
BRAND_SUPPORT_EMAIL: "\n",
|
||||
BRAND_LEGAL_PRIVACY_URL: "\t",
|
||||
BRAND_LOGO_URL: " ",
|
||||
BRAND_MAIL_PRIMARY: " ",
|
||||
})
|
||||
).toEqual({});
|
||||
});
|
||||
|
||||
it("extracts product name and site URL when provided", () => {
|
||||
expect(
|
||||
loadBrandFromEnv({
|
||||
BRAND_PRODUCT_NAME: "Acme Ops",
|
||||
BRAND_SITE_URL: "https://acme.test",
|
||||
})
|
||||
).toEqual({
|
||||
productName: "Acme Ops",
|
||||
siteUrl: "https://acme.test",
|
||||
});
|
||||
});
|
||||
|
||||
it("groups support, legal, assets and mail color overrides", () => {
|
||||
expect(
|
||||
loadBrandFromEnv({
|
||||
BRAND_SUPPORT_EMAIL: "help@acme.test",
|
||||
BRAND_SUPPORT_FROM_NAME: "Acme Help",
|
||||
BRAND_LEGAL_IMPRINT_URL: "https://acme.test/imprint",
|
||||
BRAND_LEGAL_PRIVACY_URL: "https://acme.test/privacy",
|
||||
BRAND_LEGAL_TERMS_URL: "https://acme.test/terms",
|
||||
BRAND_LOGO_URL: "https://cdn.acme.test/logo.svg",
|
||||
BRAND_FAVICON_URL: "https://cdn.acme.test/favicon.ico",
|
||||
BRAND_MAIL_PRIMARY: "#0f766e",
|
||||
BRAND_MAIL_PRIMARY_TEXT: "#ffffff",
|
||||
BRAND_MAIL_BACKGROUND: "#f5f5f5",
|
||||
BRAND_MAIL_LINK: "#0e7490",
|
||||
})
|
||||
).toEqual({
|
||||
support: { email: "help@acme.test", fromName: "Acme Help" },
|
||||
legal: {
|
||||
imprintUrl: "https://acme.test/imprint",
|
||||
privacyUrl: "https://acme.test/privacy",
|
||||
termsUrl: "https://acme.test/terms",
|
||||
},
|
||||
assets: {
|
||||
logoUrl: "https://cdn.acme.test/logo.svg",
|
||||
faviconUrl: "https://cdn.acme.test/favicon.ico",
|
||||
},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#0f766e",
|
||||
primaryText: "#ffffff",
|
||||
background: "#f5f5f5",
|
||||
link: "#0e7490",
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("composes with createBrandTokens, preserving defaults for unset env keys", () => {
|
||||
const tokens = createBrandTokens(
|
||||
loadBrandFromEnv({
|
||||
BRAND_PRODUCT_NAME: "Acme Ops",
|
||||
BRAND_MAIL_PRIMARY: "#123456",
|
||||
})
|
||||
);
|
||||
|
||||
expect(tokens.productName).toBe("Acme Ops");
|
||||
expect(tokens.siteUrl).toBe(defaultBrandTokens.siteUrl);
|
||||
expect(tokens.support).toEqual(defaultBrandTokens.support);
|
||||
expect(tokens.mail.colors.primary).toBe("#123456");
|
||||
expect(tokens.mail.colors.primaryText).toBe(defaultBrandTokens.mail.colors.primaryText);
|
||||
});
|
||||
|
||||
it("emits only partial sub-objects when only some sub-keys are present", () => {
|
||||
expect(loadBrandFromEnv({ BRAND_SUPPORT_EMAIL: "help@acme.test" })).toEqual({
|
||||
support: { email: "help@acme.test" },
|
||||
});
|
||||
expect(loadBrandFromEnv({ BRAND_LEGAL_TERMS_URL: "https://acme.test/terms" })).toEqual({
|
||||
legal: { termsUrl: "https://acme.test/terms" },
|
||||
});
|
||||
expect(loadBrandFromEnv({ BRAND_LOGO_URL: "https://cdn.acme.test/logo.svg" })).toEqual({
|
||||
assets: { logoUrl: "https://cdn.acme.test/logo.svg" },
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,63 @@
|
||||
import type { BrandTokenOverrides } from "./index.js";
|
||||
|
||||
export type BrandEnvSource = Readonly<Record<string, string | undefined>>;
|
||||
|
||||
const trimmedOrUndefined = (value: string | undefined): string | undefined => {
|
||||
if (typeof value !== "string") return undefined;
|
||||
const trimmed = value.trim();
|
||||
return trimmed ? trimmed : undefined;
|
||||
};
|
||||
|
||||
export function loadBrandFromEnv(env: BrandEnvSource): BrandTokenOverrides {
|
||||
const overrides: BrandTokenOverrides = {};
|
||||
|
||||
const productName = trimmedOrUndefined(env.BRAND_PRODUCT_NAME);
|
||||
if (productName !== undefined) overrides.productName = productName;
|
||||
|
||||
const siteUrl = trimmedOrUndefined(env.BRAND_SITE_URL);
|
||||
if (siteUrl !== undefined) overrides.siteUrl = siteUrl;
|
||||
|
||||
const supportEmail = trimmedOrUndefined(env.BRAND_SUPPORT_EMAIL);
|
||||
const supportFromName = trimmedOrUndefined(env.BRAND_SUPPORT_FROM_NAME);
|
||||
if (supportEmail !== undefined || supportFromName !== undefined) {
|
||||
const support: NonNullable<BrandTokenOverrides["support"]> = {};
|
||||
if (supportEmail !== undefined) support.email = supportEmail;
|
||||
if (supportFromName !== undefined) support.fromName = supportFromName;
|
||||
overrides.support = support;
|
||||
}
|
||||
|
||||
const imprintUrl = trimmedOrUndefined(env.BRAND_LEGAL_IMPRINT_URL);
|
||||
const privacyUrl = trimmedOrUndefined(env.BRAND_LEGAL_PRIVACY_URL);
|
||||
const termsUrl = trimmedOrUndefined(env.BRAND_LEGAL_TERMS_URL);
|
||||
if (imprintUrl !== undefined || privacyUrl !== undefined || termsUrl !== undefined) {
|
||||
const legal: NonNullable<BrandTokenOverrides["legal"]> = {};
|
||||
if (imprintUrl !== undefined) legal.imprintUrl = imprintUrl;
|
||||
if (privacyUrl !== undefined) legal.privacyUrl = privacyUrl;
|
||||
if (termsUrl !== undefined) legal.termsUrl = termsUrl;
|
||||
overrides.legal = legal;
|
||||
}
|
||||
|
||||
const logoUrl = trimmedOrUndefined(env.BRAND_LOGO_URL);
|
||||
const faviconUrl = trimmedOrUndefined(env.BRAND_FAVICON_URL);
|
||||
if (logoUrl !== undefined || faviconUrl !== undefined) {
|
||||
const assets: NonNullable<BrandTokenOverrides["assets"]> = {};
|
||||
if (logoUrl !== undefined) assets.logoUrl = logoUrl;
|
||||
if (faviconUrl !== undefined) assets.faviconUrl = faviconUrl;
|
||||
overrides.assets = assets;
|
||||
}
|
||||
|
||||
const mailPrimary = trimmedOrUndefined(env.BRAND_MAIL_PRIMARY);
|
||||
const mailPrimaryText = trimmedOrUndefined(env.BRAND_MAIL_PRIMARY_TEXT);
|
||||
const mailBackground = trimmedOrUndefined(env.BRAND_MAIL_BACKGROUND);
|
||||
const mailLink = trimmedOrUndefined(env.BRAND_MAIL_LINK);
|
||||
if (mailPrimary !== undefined || mailPrimaryText !== undefined || mailBackground !== undefined || mailLink !== undefined) {
|
||||
const colors: NonNullable<NonNullable<BrandTokenOverrides["mail"]>["colors"]> = {};
|
||||
if (mailPrimary !== undefined) colors.primary = mailPrimary;
|
||||
if (mailPrimaryText !== undefined) colors.primaryText = mailPrimaryText;
|
||||
if (mailBackground !== undefined) colors.background = mailBackground;
|
||||
if (mailLink !== undefined) colors.link = mailLink;
|
||||
overrides.mail = { colors };
|
||||
}
|
||||
|
||||
return overrides;
|
||||
}
|
||||
@@ -0,0 +1,226 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import {
|
||||
brandCssVariables,
|
||||
createBrandTokens,
|
||||
defaultBrandLinks,
|
||||
defaultBrandTokens,
|
||||
resolveTransactionalBrandTokens,
|
||||
} from "./index.js";
|
||||
|
||||
describe("brand token helpers", () => {
|
||||
it("exposes stable default brand tokens", () => {
|
||||
expect(defaultBrandTokens).toMatchObject({
|
||||
productName: "ToolCTRL",
|
||||
siteUrl: "https://tool-ctrl.de",
|
||||
legal: {
|
||||
imprintUrl: "https://tool-ctrl.de/impressum",
|
||||
privacyUrl: "https://tool-ctrl.de/datenschutz",
|
||||
termsUrl: "https://tool-ctrl.de/agb",
|
||||
},
|
||||
support: {
|
||||
email: "info@tool-ctrl.de",
|
||||
fromName: "ToolCTRL Support",
|
||||
},
|
||||
assets: {
|
||||
logoUrl: "/android-chrome-512x512.png",
|
||||
faviconUrl: "/favicon.ico",
|
||||
},
|
||||
socials: {},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#2563eb",
|
||||
primaryText: "#ffffff",
|
||||
link: "#2563eb",
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("falls back to defaults for empty overrides", () => {
|
||||
const tokens = createBrandTokens({
|
||||
productName: " ",
|
||||
siteUrl: "",
|
||||
legal: {
|
||||
imprintUrl: "",
|
||||
privacyUrl: "\n",
|
||||
},
|
||||
support: {
|
||||
email: "",
|
||||
fromName: "\t",
|
||||
},
|
||||
assets: {
|
||||
logoUrl: null,
|
||||
faviconUrl: " ",
|
||||
},
|
||||
socials: {
|
||||
linkedinUrl: "",
|
||||
xUrl: " ",
|
||||
},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "",
|
||||
link: " ",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(tokens.productName).toBe(defaultBrandTokens.productName);
|
||||
expect(tokens.siteUrl).toBe(defaultBrandTokens.siteUrl);
|
||||
expect(tokens.legal.imprintUrl).toBe(defaultBrandTokens.legal.imprintUrl);
|
||||
expect(tokens.legal.privacyUrl).toBe(defaultBrandTokens.legal.privacyUrl);
|
||||
expect(tokens.legal.termsUrl).toBe(defaultBrandTokens.legal.termsUrl);
|
||||
expect(tokens.support.email).toBe(defaultBrandTokens.support.email);
|
||||
expect(tokens.support.fromName).toBe(defaultBrandTokens.support.fromName);
|
||||
expect(tokens.assets.logoUrl).toBe(defaultBrandTokens.assets.logoUrl);
|
||||
expect(tokens.assets.faviconUrl).toBe(defaultBrandTokens.assets.faviconUrl);
|
||||
expect(tokens.socials).toEqual(defaultBrandTokens.socials);
|
||||
expect(tokens.mail.colors.primary).toBe(defaultBrandTokens.mail.colors.primary);
|
||||
expect(tokens.mail.colors.link).toBe(defaultBrandTokens.mail.colors.link);
|
||||
});
|
||||
|
||||
it("applies non-empty overrides while preserving unspecified defaults", () => {
|
||||
const tokens = createBrandTokens({
|
||||
productName: "Acme Ops",
|
||||
siteUrl: "https://acme.test",
|
||||
legal: {
|
||||
imprintUrl: "https://acme.test/imprint",
|
||||
},
|
||||
support: {
|
||||
fromName: "Acme Support",
|
||||
},
|
||||
assets: {
|
||||
logoUrl: "https://cdn.acme.test/logo.svg",
|
||||
},
|
||||
socials: {
|
||||
linkedinUrl: "https://linkedin.com/company/acme",
|
||||
},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#123456",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(tokens.productName).toBe("Acme Ops");
|
||||
expect(tokens.siteUrl).toBe("https://acme.test");
|
||||
expect(tokens.legal.imprintUrl).toBe("https://acme.test/imprint");
|
||||
expect(tokens.legal.privacyUrl).toBe(defaultBrandTokens.legal.privacyUrl);
|
||||
expect(tokens.support.email).toBe(defaultBrandTokens.support.email);
|
||||
expect(tokens.support.fromName).toBe("Acme Support");
|
||||
expect(tokens.assets.logoUrl).toBe("https://cdn.acme.test/logo.svg");
|
||||
expect(tokens.assets.faviconUrl).toBe(defaultBrandTokens.assets.faviconUrl);
|
||||
expect(tokens.socials.linkedinUrl).toBe("https://linkedin.com/company/acme");
|
||||
expect(tokens.mail.colors.primary).toBe("#123456");
|
||||
expect(tokens.mail.colors.primaryText).toBe(defaultBrandTokens.mail.colors.primaryText);
|
||||
});
|
||||
|
||||
it("resolves app configuration fallbacks defensively", () => {
|
||||
const tokens = resolveTransactionalBrandTokens({
|
||||
appName: "Acme Ops",
|
||||
siteUrl: "https://portal.acme.test",
|
||||
supportEmail: "help@acme.test",
|
||||
supportFromName: "Help Desk",
|
||||
logoUrl: "https://cdn.acme.test/app-logo.png",
|
||||
faviconUrl: "https://cdn.acme.test/favicon.ico",
|
||||
imprintUrl: "https://acme.test/imprint",
|
||||
privacyUrl: "https://acme.test/privacy",
|
||||
termsUrl: "https://acme.test/terms",
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#0f766e",
|
||||
link: "#0e7490",
|
||||
},
|
||||
},
|
||||
brand: {
|
||||
productName: "",
|
||||
support: {
|
||||
email: "brand-help@acme.test",
|
||||
fromName: " ",
|
||||
},
|
||||
socials: {
|
||||
githubUrl: "https://github.com/acme",
|
||||
},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#dc2626",
|
||||
link: "",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(tokens.productName).toBe("Acme Ops");
|
||||
expect(tokens.siteUrl).toBe("https://portal.acme.test");
|
||||
expect(tokens.support.email).toBe("brand-help@acme.test");
|
||||
expect(tokens.support.fromName).toBe("Help Desk");
|
||||
expect(tokens.assets.logoUrl).toBe("https://cdn.acme.test/app-logo.png");
|
||||
expect(tokens.assets.faviconUrl).toBe("https://cdn.acme.test/favicon.ico");
|
||||
expect(tokens.legal.imprintUrl).toBe("https://acme.test/imprint");
|
||||
expect(tokens.legal.privacyUrl).toBe("https://acme.test/privacy");
|
||||
expect(tokens.legal.termsUrl).toBe("https://acme.test/terms");
|
||||
expect(tokens.socials.githubUrl).toBe("https://github.com/acme");
|
||||
expect(tokens.mail.colors.primary).toBe("#dc2626");
|
||||
expect(tokens.mail.colors.link).toBe("#0e7490");
|
||||
});
|
||||
|
||||
it("does not allow empty app configuration values to replace defaults", () => {
|
||||
const tokens = resolveTransactionalBrandTokens({
|
||||
productName: "",
|
||||
siteUrl: "",
|
||||
appName: " ",
|
||||
name: "\t",
|
||||
supportEmail: "",
|
||||
supportFromName: " ",
|
||||
emailFromName: "\n",
|
||||
logoUrl: "",
|
||||
faviconUrl: " ",
|
||||
imprintUrl: "",
|
||||
privacyUrl: " ",
|
||||
termsUrl: "\t",
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "",
|
||||
primaryText: " ",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(tokens.productName).toBe(defaultBrandTokens.productName);
|
||||
expect(tokens.siteUrl).toBe(defaultBrandTokens.siteUrl);
|
||||
expect(tokens.support).toEqual(defaultBrandTokens.support);
|
||||
expect(tokens.assets).toEqual(defaultBrandTokens.assets);
|
||||
expect(tokens.legal).toEqual(defaultBrandTokens.legal);
|
||||
expect(tokens.mail.colors.primary).toBe(defaultBrandTokens.mail.colors.primary);
|
||||
expect(tokens.mail.colors.primaryText).toBe(defaultBrandTokens.mail.colors.primaryText);
|
||||
});
|
||||
|
||||
it("emits deterministic CSS variables", () => {
|
||||
const tokens = createBrandTokens({
|
||||
productName: "Acme Ops",
|
||||
assets: {
|
||||
logoUrl: "https://cdn.acme.test/logo.svg",
|
||||
},
|
||||
mail: {
|
||||
colors: {
|
||||
primary: "#123456",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(brandCssVariables(tokens)).toEqual({
|
||||
"--toolctrl-product-name": "Acme Ops",
|
||||
"--toolctrl-site-url": defaultBrandLinks.siteUrl,
|
||||
"--toolctrl-logo-url": "url(https://cdn.acme.test/logo.svg)",
|
||||
"--toolctrl-favicon-url": `url(${defaultBrandTokens.assets.faviconUrl})`,
|
||||
"--toolctrl-mail-background": defaultBrandTokens.mail.colors.background,
|
||||
"--toolctrl-mail-surface": defaultBrandTokens.mail.colors.surface,
|
||||
"--toolctrl-mail-primary": "#123456",
|
||||
"--toolctrl-mail-primary-text": defaultBrandTokens.mail.colors.primaryText,
|
||||
"--toolctrl-mail-text": defaultBrandTokens.mail.colors.text,
|
||||
"--toolctrl-mail-muted-text": defaultBrandTokens.mail.colors.mutedText,
|
||||
"--toolctrl-mail-border": defaultBrandTokens.mail.colors.border,
|
||||
"--toolctrl-mail-link": defaultBrandTokens.mail.colors.link,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,237 @@
|
||||
export type BrandLegalLinks = {
|
||||
imprintUrl: string;
|
||||
privacyUrl: string;
|
||||
termsUrl: string;
|
||||
};
|
||||
|
||||
export type BrandSupportContact = {
|
||||
email: string;
|
||||
fromName: string;
|
||||
};
|
||||
|
||||
export type BrandAssets = {
|
||||
logoUrl: string;
|
||||
faviconUrl: string;
|
||||
};
|
||||
|
||||
const brandSocialLinkKeys = ["linkedinUrl", "xUrl", "instagramUrl", "githubUrl", "youtubeUrl", "discordUrl"] as const;
|
||||
|
||||
type BrandSocialLinkKey = (typeof brandSocialLinkKeys)[number];
|
||||
|
||||
export type BrandSocialLinks = Partial<Record<BrandSocialLinkKey, string>>;
|
||||
|
||||
export type BrandLinkConfiguration = {
|
||||
siteUrl: string;
|
||||
legal: BrandLegalLinks;
|
||||
support: BrandSupportContact;
|
||||
assets: BrandAssets;
|
||||
socials: BrandSocialLinks;
|
||||
};
|
||||
|
||||
export type TransactionalMailColors = {
|
||||
background: string;
|
||||
surface: string;
|
||||
primary: string;
|
||||
primaryText: string;
|
||||
text: string;
|
||||
mutedText: string;
|
||||
border: string;
|
||||
link: string;
|
||||
};
|
||||
|
||||
export type ToolCTRLBrandTokens = {
|
||||
productName: string;
|
||||
siteUrl: string;
|
||||
legal: BrandLegalLinks;
|
||||
support: BrandSupportContact;
|
||||
assets: BrandAssets;
|
||||
socials: BrandSocialLinks;
|
||||
mail: {
|
||||
colors: TransactionalMailColors;
|
||||
};
|
||||
};
|
||||
|
||||
export type BrandTokens = ToolCTRLBrandTokens;
|
||||
|
||||
export type BrandTokenOverrides = Partial<{
|
||||
productName: string | null;
|
||||
siteUrl: string | null;
|
||||
legal: Partial<Record<keyof BrandLegalLinks, string | null>> | null;
|
||||
support: Partial<Record<keyof BrandSupportContact, string | null>> | null;
|
||||
assets: Partial<Record<keyof BrandAssets, string | null>> | null;
|
||||
socials: Partial<Record<BrandSocialLinkKey, string | null>> | null;
|
||||
mail: {
|
||||
colors?: Partial<Record<keyof TransactionalMailColors, string | null>> | null;
|
||||
} | null;
|
||||
}>;
|
||||
|
||||
export type AppConfigurationLike = Partial<{
|
||||
productName: string | null;
|
||||
siteUrl: string | null;
|
||||
appName: string | null;
|
||||
name: string | null;
|
||||
supportEmail: string | null;
|
||||
supportFromName: string | null;
|
||||
emailFromName: string | null;
|
||||
logoUrl: string | null;
|
||||
faviconUrl: string | null;
|
||||
imprintUrl: string | null;
|
||||
privacyUrl: string | null;
|
||||
termsUrl: string | null;
|
||||
brand: BrandTokenOverrides | null;
|
||||
mail: {
|
||||
colors?: Partial<Record<keyof TransactionalMailColors, string | null>> | null;
|
||||
} | null;
|
||||
}>;
|
||||
|
||||
export const defaultBrandLinks: BrandLinkConfiguration = {
|
||||
siteUrl: "https://tool-ctrl.de",
|
||||
legal: {
|
||||
imprintUrl: "https://tool-ctrl.de/impressum",
|
||||
privacyUrl: "https://tool-ctrl.de/datenschutz",
|
||||
termsUrl: "https://tool-ctrl.de/agb",
|
||||
},
|
||||
support: {
|
||||
email: "info@tool-ctrl.de",
|
||||
fromName: "ToolCTRL Support",
|
||||
},
|
||||
assets: {
|
||||
logoUrl: "/android-chrome-512x512.png",
|
||||
faviconUrl: "/favicon.ico",
|
||||
},
|
||||
socials: {},
|
||||
};
|
||||
|
||||
export const defaultBrandTokens: BrandTokens = {
|
||||
productName: "ToolCTRL",
|
||||
siteUrl: defaultBrandLinks.siteUrl,
|
||||
legal: defaultBrandLinks.legal,
|
||||
support: defaultBrandLinks.support,
|
||||
assets: defaultBrandLinks.assets,
|
||||
socials: defaultBrandLinks.socials,
|
||||
mail: {
|
||||
colors: {
|
||||
background: "#f6f8fb",
|
||||
surface: "#ffffff",
|
||||
primary: "#2563eb",
|
||||
primaryText: "#ffffff",
|
||||
text: "#111827",
|
||||
mutedText: "#6b7280",
|
||||
border: "#e5e7eb",
|
||||
link: "#2563eb",
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const nonEmpty = (value: string | null | undefined): string | undefined => {
|
||||
const trimmed = value?.trim();
|
||||
return trimmed ? trimmed : undefined;
|
||||
};
|
||||
|
||||
const pickFirst = (...values: Array<string | null | undefined>): string | undefined => {
|
||||
for (const value of values) {
|
||||
const resolved = nonEmpty(value);
|
||||
if (resolved) return resolved;
|
||||
}
|
||||
return undefined;
|
||||
};
|
||||
|
||||
const resolveSocialLinks = (overrides?: Partial<Record<BrandSocialLinkKey, string | null>> | null): BrandSocialLinks => {
|
||||
const socials: BrandSocialLinks = {};
|
||||
|
||||
for (const key of brandSocialLinkKeys) {
|
||||
const value = nonEmpty(overrides?.[key]) ?? defaultBrandLinks.socials[key];
|
||||
if (value) {
|
||||
socials[key] = value;
|
||||
}
|
||||
}
|
||||
|
||||
return socials;
|
||||
};
|
||||
|
||||
export function createBrandTokens(overrides: BrandTokenOverrides = {}): BrandTokens {
|
||||
return {
|
||||
productName: nonEmpty(overrides.productName) ?? defaultBrandTokens.productName,
|
||||
siteUrl: nonEmpty(overrides.siteUrl) ?? defaultBrandTokens.siteUrl,
|
||||
legal: {
|
||||
imprintUrl: nonEmpty(overrides.legal?.imprintUrl) ?? defaultBrandTokens.legal.imprintUrl,
|
||||
privacyUrl: nonEmpty(overrides.legal?.privacyUrl) ?? defaultBrandTokens.legal.privacyUrl,
|
||||
termsUrl: nonEmpty(overrides.legal?.termsUrl) ?? defaultBrandTokens.legal.termsUrl,
|
||||
},
|
||||
support: {
|
||||
email: nonEmpty(overrides.support?.email) ?? defaultBrandTokens.support.email,
|
||||
fromName: nonEmpty(overrides.support?.fromName) ?? defaultBrandTokens.support.fromName,
|
||||
},
|
||||
assets: {
|
||||
logoUrl: nonEmpty(overrides.assets?.logoUrl) ?? defaultBrandTokens.assets.logoUrl,
|
||||
faviconUrl: nonEmpty(overrides.assets?.faviconUrl) ?? defaultBrandTokens.assets.faviconUrl,
|
||||
},
|
||||
socials: resolveSocialLinks(overrides.socials),
|
||||
mail: {
|
||||
colors: {
|
||||
background: nonEmpty(overrides.mail?.colors?.background) ?? defaultBrandTokens.mail.colors.background,
|
||||
surface: nonEmpty(overrides.mail?.colors?.surface) ?? defaultBrandTokens.mail.colors.surface,
|
||||
primary: nonEmpty(overrides.mail?.colors?.primary) ?? defaultBrandTokens.mail.colors.primary,
|
||||
primaryText: nonEmpty(overrides.mail?.colors?.primaryText) ?? defaultBrandTokens.mail.colors.primaryText,
|
||||
text: nonEmpty(overrides.mail?.colors?.text) ?? defaultBrandTokens.mail.colors.text,
|
||||
mutedText: nonEmpty(overrides.mail?.colors?.mutedText) ?? defaultBrandTokens.mail.colors.mutedText,
|
||||
border: nonEmpty(overrides.mail?.colors?.border) ?? defaultBrandTokens.mail.colors.border,
|
||||
link: nonEmpty(overrides.mail?.colors?.link) ?? defaultBrandTokens.mail.colors.link,
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function resolveTransactionalBrandTokens(appConfigurationLike: AppConfigurationLike | null | undefined): BrandTokens {
|
||||
const config = appConfigurationLike ?? {};
|
||||
|
||||
return createBrandTokens({
|
||||
productName: pickFirst(config.brand?.productName, config.productName, config.appName, config.name),
|
||||
siteUrl: pickFirst(config.brand?.siteUrl, config.siteUrl),
|
||||
legal: {
|
||||
imprintUrl: pickFirst(config.brand?.legal?.imprintUrl, config.imprintUrl),
|
||||
privacyUrl: pickFirst(config.brand?.legal?.privacyUrl, config.privacyUrl),
|
||||
termsUrl: pickFirst(config.brand?.legal?.termsUrl, config.termsUrl),
|
||||
},
|
||||
support: {
|
||||
email: pickFirst(config.brand?.support?.email, config.supportEmail),
|
||||
fromName: pickFirst(config.brand?.support?.fromName, config.supportFromName, config.emailFromName),
|
||||
},
|
||||
assets: {
|
||||
logoUrl: pickFirst(config.brand?.assets?.logoUrl, config.logoUrl),
|
||||
faviconUrl: pickFirst(config.brand?.assets?.faviconUrl, config.faviconUrl),
|
||||
},
|
||||
socials: config.brand?.socials,
|
||||
mail: {
|
||||
colors: {
|
||||
background: pickFirst(config.brand?.mail?.colors?.background, config.mail?.colors?.background),
|
||||
surface: pickFirst(config.brand?.mail?.colors?.surface, config.mail?.colors?.surface),
|
||||
primary: pickFirst(config.brand?.mail?.colors?.primary, config.mail?.colors?.primary),
|
||||
primaryText: pickFirst(config.brand?.mail?.colors?.primaryText, config.mail?.colors?.primaryText),
|
||||
text: pickFirst(config.brand?.mail?.colors?.text, config.mail?.colors?.text),
|
||||
mutedText: pickFirst(config.brand?.mail?.colors?.mutedText, config.mail?.colors?.mutedText),
|
||||
border: pickFirst(config.brand?.mail?.colors?.border, config.mail?.colors?.border),
|
||||
link: pickFirst(config.brand?.mail?.colors?.link, config.mail?.colors?.link),
|
||||
},
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export { loadBrandFromEnv, type BrandEnvSource } from "./env.js";
|
||||
|
||||
export function brandCssVariables(tokens: BrandTokens): Record<string, string> {
|
||||
return {
|
||||
"--toolctrl-product-name": tokens.productName,
|
||||
"--toolctrl-site-url": tokens.siteUrl,
|
||||
"--toolctrl-logo-url": `url(${tokens.assets.logoUrl})`,
|
||||
"--toolctrl-favicon-url": `url(${tokens.assets.faviconUrl})`,
|
||||
"--toolctrl-mail-background": tokens.mail.colors.background,
|
||||
"--toolctrl-mail-surface": tokens.mail.colors.surface,
|
||||
"--toolctrl-mail-primary": tokens.mail.colors.primary,
|
||||
"--toolctrl-mail-primary-text": tokens.mail.colors.primaryText,
|
||||
"--toolctrl-mail-text": tokens.mail.colors.text,
|
||||
"--toolctrl-mail-muted-text": tokens.mail.colors.mutedText,
|
||||
"--toolctrl-mail-border": tokens.mail.colors.border,
|
||||
"--toolctrl-mail-link": tokens.mail.colors.link,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"allowJs": false,
|
||||
"allowImportingTsExtensions": false,
|
||||
"lib": ["ES2022"],
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noEmit": true,
|
||||
"target": "ES2022",
|
||||
"types": ["node"]
|
||||
},
|
||||
"include": ["src/**/*.ts"]
|
||||
}
|
||||
Reference in new issue
Block a user