@cratis/cast 0.1.0 → 0.2.1

package/README.md

@@ -10,4 +10,6 @@ import { defineConfig } from 'astro/config';
 export default defineConfig({ integrations: [cast()] });
 ```
 
-The quickest start is `npm create @cratis/cast@latest`. Documentation: [getting started](https://github.com/Cratis/Cast/blob/main/Documentation/getting-started.md), [cast.yaml reference](https://github.com/Cratis/Cast/blob/main/Documentation/cast-yaml.md), [badges and the registry](https://github.com/Cratis/Cast/blob/main/Documentation/badges-and-registry.md).
+The quickest start is `npm create @cratis/cast@latest`. Documentation: [getting started](https://github.com/Cratis/Cast/blob/main/Documentation/getting-started.md), [cast.yaml reference](https://github.com/Cratis/Cast/blob/main/Documentation/cast-yaml.md), [cast.json reference](https://github.com/Cratis/Cast/blob/main/Documentation/cast-json.md), [badges and the registry](https://github.com/Cratis/Cast/blob/main/Documentation/badges-and-registry.md).
+
+Besides the integration, the package exports what other Astro projects need to render a Cast profile: `@cratis/cast/profile` (`castView`, the hosts, the browser data), `@cratis/cast/machine` (`castJson`, `profileFromCastJson`, the cast.json schema) and the page components `@cratis/cast/site/pages/ProfilePage.astro` and `CvPage.astro`. The JSON Schemas are `@cratis/cast/cast.schema.json` (cast.yaml) and `@cratis/cast/cast-json.schema.json` (cast.json, version 2).

package/badges/RegistryMember.ts

@@ -10,6 +10,8 @@ export type RegistryMember = {
     since?: string;
     role?: string;
     site?: string;
+    /** URL of the member's /cast.json, for sites that publish it elsewhere. Defaults to `<site>/cast.json`. */
+    profile?: string;
     company?: string;
     /** 1-based line in members.yaml where this entry starts, for "verified from" links. */
     line?: number;

package/badges/badgeSvg.ts

@@ -94,6 +94,15 @@ export type BadgeCardOptions = {
     since?: string;
 };
 
+const months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
+
+/** `2024-06` as `Jun 2024`, matching the directory's cards; anything else is shown as given. */
+const monthYear = (since: string): string => {
+    const match = /^(\d{4})-(\d{2})$/.exec(since);
+    const month = match ? months[Number(match[2]) - 1] : undefined;
+    return match && month ? `${month} ${match[1]}` : since;
+};
+
 /**
  * The large badge card (480 × 168): a dark card with a tier-colored edge, the Cratis mark, the tier in
  * the italic serif and the verification address. Meant for READMEs, slides and profile pages.
@@ -106,7 +115,7 @@ export function badgeCardSvg(tier: Tier | undefined, options: BadgeCardOptions):
     const handle = options.handle.toLowerCase();
     const address = `${castDirectoryUrl.replace(/^https:\/\//, '')}/${handle}`;
     const who = options.name ? `${options.name} · @${options.handle}` : `@${options.handle}`;
-    const sinceText = options.since ? ` · since ${options.since}` : '';
+    const sinceText = options.since ? ` · since ${monthYear(options.since)}` : '';
     const title = tier ? `${who}: Cratis Cast ${style.label}` : `${who}: not verified in the Cratis Cast`;
 
     return `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}" viewBox="0 0 ${width} ${height}" role="img" aria-label="${escapeXml(title)}">

package/badges/registry.ts

@@ -12,6 +12,7 @@ export const registryMemberSchema = z.object({
     since: z.string().regex(/^\d{4}-\d{2}$/, 'Use YYYY-MM').optional(),
     role: z.string().min(1).optional(),
     site: z.url({ protocol: /^https$/ }).optional(),
+    profile: z.url({ protocol: /^https$/ }).optional(),
     company: z.string().min(1).optional(),
 }).strict();
 
@@ -58,6 +59,10 @@ function entryLines(document: ReturnType<typeof parseDocument>, yamlText: string
     });
 }
 
+/** Where the directory reads a member's profile: `profile`, else `<site>/cast.json`, else nowhere. */
+export const profileUrlOf = (member: Pick<RegistryMember, 'site' | 'profile'>): string | undefined =>
+    member.profile ?? (member.site ? new URL('/cast.json', member.site).toString() : undefined);
+
 /** Finds a member by GitHub login, case-insensitively. */
 export const findMember = (members: readonly RegistryMember[], handle: string): RegistryMember | undefined =>
     members.find(member => member.github.toLowerCase() === handle.toLowerCase());