Allow adding a default ist of platforms URLs for social links

Author: essential-randomness

.changeset/socials-custom-domains.md

@@ -0,0 +1,5 @@
+---
+"@fujocoded/zod-transform-socials": patch
+---
+
+Add `createSocialsTransformer` for registering custom domains for platforms without known URL shapes (currently `mastodon`), so self-hosted instances can be matched without needing to spell out `platform` every time.

zod-transform-socials/README.md

@@ -54,3 +54,39 @@ interface Props {
   contacts: SocialLinksData;
 }
 ```
+
+## Adding custom domains
+
+For platforms without a fixed domain, like `mastodon`, the built-in matchers
+can only know a fixed set of domains (e.g. `mastodon.social`,
+`mastodon.world`). If you use a different instance and you're tired of
+spelling out `platform: mastodon` every time, you can use `createSocialsTransformer`
+and pass platform domains via `domains`:
+
+```ts
+import { createSocialsTransformer } from "@fujocoded/zod-transform-socials";
+
+const { SocialLinks, transformSocial } = createSocialsTransformer({
+  domains: {
+    mastodon: ["blorbo.social", "tech.lgbt", "indiepocalypse.social"],
+  },
+});
+
+export const teamCollection = defineCollection({
+  type: "data",
+  schema: (tools) =>
+    z.object({
+      // ...
+      contacts: SocialLinks,
+    }),
+});
+```
+
+Only platforms with a registered URL shape can be configured this way
+(currently: `mastodon`). If you need a platform that isn't covered, please
+open a PR to add its URL-shape builder to `DOMAIN_PATTERNS` in the library —
+that way every consumer benefits and patterns stay correct.
+
+The bare `SocialLinks` / `transformSocial` exports still work and use the
+default configuration — only switch to `createSocialsTransformer` when you
+need to add domains.

zod-transform-socials/index.ts

@@ -1,6 +1,15 @@
 import z from "zod";
-import { extractSocialData, getSocialIcon } from "./socials.ts";
-import type { SOCIAL_TYPES as INNER_SOCIAL_TYPES } from "./social-links.ts";
+import {
+  createExtractSocialData,
+  extractSocialData,
+  getSocialIcon,
+} from "./socials.ts";
+import {
+  createSocialLinks,
+  type CreateSocialLinksConfig,
+  type DomainShortcuts,
+  type SOCIAL_TYPES as INNER_SOCIAL_TYPES,
+} from "./social-links.ts";
 
 export const SocialsSchema = z.union([
   z.string().url(),
@@ -14,26 +23,47 @@ export const SocialsSchema = z.union([
 
 export type SocialsSchema = z.infer<typeof SocialsSchema>;
 
-export const transformSocial = (social: SocialsSchema) => {
-  if (typeof social == "string") {
-    return extractSocialData({ url: social });
-  }
-  const { icon, url, platform, username } = social;
-  const data = extractSocialData({ url });
-
-  return {
-    icon:
-      icon ??
-      (platform === undefined
-        ? data.icon
-        : getSocialIcon(platform as INNER_SOCIAL_TYPES)),
-    url: url ?? data.url,
-    platform: platform ?? data.platform,
-    username: username ?? data.username,
+export type SOCIAL_TYPES = INNER_SOCIAL_TYPES;
+export type { DomainShortcuts };
+
+export type CreateSocialsConfig = CreateSocialLinksConfig;
+
+const buildTransformSocial =
+  (extractor: ReturnType<typeof createExtractSocialData>) =>
+  (social: SocialsSchema) => {
+    if (typeof social == "string") {
+      return extractor({ url: social });
+    }
+    const { icon, url, platform, username } = social;
+    const data = extractor({ url });
+
+    return {
+      icon:
+        icon ??
+        (platform === undefined
+          ? data.icon
+          : getSocialIcon(platform as INNER_SOCIAL_TYPES)),
+      url: url ?? data.url,
+      platform: platform ?? data.platform,
+      username: username ?? data.username,
+    };
   };
+
+export const createSocialsTransformer = (config: CreateSocialsConfig = {}) => {
+  const socialLinks = createSocialLinks(config);
+  const extractor = createExtractSocialData(socialLinks);
+  const transformSocial = buildTransformSocial(extractor);
+
+  const SocialLinks = z
+    .array(SocialsSchema)
+    .default([])
+    .transform((socialUrls) => socialUrls.map(transformSocial));
+
+  return { SocialsSchema, transformSocial, SocialLinks, socialLinks };
 };
 
-export type SOCIAL_TYPES = INNER_SOCIAL_TYPES;
+// Export a default transformer
+export const transformSocial = buildTransformSocial(extractSocialData);
 
 export const SocialLinks = z
   .array(SocialsSchema)