@eventcatalog/core 3.43.0 → 3.44.0

package/eventcatalog/src/pages/directory/[type]/index.astro

@@ -33,6 +33,8 @@ function mapToItem(i: any) {
           id: d.data.id,
           name: d.data.name,
           // @ts-ignore
+          source: d.data?.source,
+          // @ts-ignore
           role: d.data?.role,
           // @ts-ignore
           avatarUrl: d.data?.avatarUrl,

package/eventcatalog/src/pages/docs/teams/[id]/index.astro

@@ -7,6 +7,7 @@ import type { CollectionEntry } from 'astro:content';
 import OwnersList from '@components/Lists/OwnersList';
 import PillListFlat from '@components/Lists/PillListFlat';
 import EnvelopeIcon from '@heroicons/react/16/solid/EnvelopeIcon';
+import { Github } from 'lucide-react';
 import { formatAdrStatus } from '@utils/collections/adrs';
 import { buildUrl } from '@utils/url-builder';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
@@ -78,6 +79,9 @@ const ownedAdrsList = adrs.map((p) => ({
 }));
 
 const pageTitle = `Team | ${props.data.name}`;
+const source = props.data.source;
+const sourceLabel = source?.provider === 'github' ? 'GitHub' : source?.provider;
+const sourceTitle = sourceLabel ? `Synced from ${sourceLabel}` : undefined;
 ---
 
 <VerticalSideBarLayout title={pageTitle} description={props.data.summary}>
@@ -92,11 +96,6 @@ const pageTitle = `Team | ${props.data.name}`;
           <div class="flex justify-start">
             <div class="flex flex-col justify-between space-y-3">
               <div>
-                <span
-                  class="inline-flex items-center px-2.5 py-0.5 rounded-md text-xs font-medium bg-[rgb(var(--ec-content-hover))] text-[rgb(var(--ec-page-text-muted))] mb-2"
-                >
-                  Team
-                </span>
                 <h2 class="text-3xl font-bold text-[rgb(var(--ec-page-text))]">{props.data.name}</h2>
               </div>
               {
@@ -140,6 +139,31 @@ const pageTitle = `Team | ${props.data.name}`;
                     </a>
                   )
                 }
+                {
+                  source && sourceLabel && source.url && (
+                    <a
+                      href={source.url}
+                      target="_blank"
+                      rel="noopener noreferrer"
+                      title={sourceTitle}
+                      class="inline-flex items-center gap-1.5 text-sm text-[rgb(var(--ec-page-text-muted))] hover:text-[rgb(var(--ec-page-text))] transition-colors"
+                    >
+                      {source.provider === 'github' && <Github className="w-4 h-4 text-[rgb(var(--ec-icon-color))]" />}
+                      <span>{sourceLabel}</span>
+                    </a>
+                  )
+                }
+                {
+                  source && sourceLabel && !source.url && (
+                    <span
+                      title={sourceTitle}
+                      class="inline-flex items-center gap-1.5 text-sm text-[rgb(var(--ec-page-text-muted))]"
+                    >
+                      {source.provider === 'github' && <Github className="w-4 h-4 text-[rgb(var(--ec-icon-color))]" />}
+                      <span>{sourceLabel}</span>
+                    </span>
+                  )
+                }
               </div>
             </div>
           </div>

package/eventcatalog/src/pages/docs/users/[id]/index.astro

@@ -7,6 +7,7 @@ import type { CollectionEntry } from 'astro:content';
 import OwnersList from '@components/Lists/OwnersList';
 import PillListFlat from '@components/Lists/PillListFlat';
 import EnvelopeIcon from '@heroicons/react/16/solid/EnvelopeIcon';
+import { Github } from 'lucide-react';
 import { formatAdrStatus } from '@utils/collections/adrs';
 import { buildUrl } from '@utils/url-builder';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
@@ -75,6 +76,9 @@ const associatedTeams = teams.map((o) => ({
 }));
 
 const pageTitle = `User | ${props.data.name}`;
+const source = props.data.source;
+const sourceLabel = source?.provider === 'github' ? 'GitHub' : source?.provider;
+const sourceTitle = sourceLabel ? `Synced from ${sourceLabel}` : undefined;
 ---
 
 <VerticalSideBarLayout title={pageTitle}>
@@ -141,6 +145,31 @@ const pageTitle = `User | ${props.data.name}`;
                     </a>
                   )
                 }
+                {
+                  source && sourceLabel && source.url && (
+                    <a
+                      href={source.url}
+                      target="_blank"
+                      rel="noopener noreferrer"
+                      title={sourceTitle}
+                      class="inline-flex items-center gap-1.5 text-sm text-[rgb(var(--ec-page-text-muted))] hover:text-[rgb(var(--ec-page-text))] transition-colors"
+                    >
+                      {source.provider === 'github' && <Github className="w-4 h-4 text-[rgb(var(--ec-icon-color))]" />}
+                      <span>{sourceLabel}</span>
+                    </a>
+                  )
+                }
+                {
+                  source && sourceLabel && !source.url && (
+                    <span
+                      title={sourceTitle}
+                      class="inline-flex items-center gap-1.5 text-sm text-[rgb(var(--ec-page-text-muted))]"
+                    >
+                      {source.provider === 'github' && <Github className="w-4 h-4 text-[rgb(var(--ec-icon-color))]" />}
+                      <span>{sourceLabel}</span>
+                    </span>
+                  )
+                }
               </div>
             </div>
           </div>

package/eventcatalog/src/stores/eventcatalog-store.spec.ts

@@ -0,0 +1,60 @@
+import { mkdtemp, readFile, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { EventCatalogStore } from './eventcatalog-store';
+
+type TestStoreResources = {
+  users: { id: string; name: string }[];
+  teams: { id: string; name: string }[];
+};
+
+describe('EventCatalogStore', () => {
+  it('writes one collection while preserving the rest of the store', async () => {
+    const tempDir = await mkdtemp(path.join(tmpdir(), 'eventcatalog-store-'));
+    const storePath = EventCatalogStore.getStorePath(tempDir, 'directory');
+    const store = new EventCatalogStore<TestStoreResources>({
+      storePath,
+      resources: {
+        users: [],
+        teams: [],
+      },
+    });
+
+    try {
+      await store.writeCollection('teams', [{ id: 'platform', name: 'Platform' }]);
+      await store.writeCollection('users', [{ id: 'jane', name: 'Jane' }]);
+
+      const stored = JSON.parse(await readFile(storePath, 'utf8'));
+      expect(stored).toMatchObject({
+        version: '1',
+        resources: {
+          users: [{ id: 'jane', name: 'Jane' }],
+          teams: [{ id: 'platform', name: 'Platform' }],
+        },
+      });
+      expect(stored.generatedAt).toEqual(expect.any(String));
+    } finally {
+      await rm(tempDir, { recursive: true, force: true });
+    }
+  });
+
+  it('does not create a store file when clearing a collection that has not been generated', async () => {
+    const tempDir = await mkdtemp(path.join(tmpdir(), 'eventcatalog-store-'));
+    const storePath = EventCatalogStore.getStorePath(tempDir, 'directory');
+    const store = new EventCatalogStore<TestStoreResources>({
+      storePath,
+      resources: {
+        users: [],
+        teams: [],
+      },
+    });
+
+    try {
+      await store.clearCollectionIfStoreExists('users');
+      expect(await store.exists()).toBe(false);
+    } finally {
+      await rm(tempDir, { recursive: true, force: true });
+    }
+  });
+});

package/eventcatalog/src/stores/eventcatalog-store.ts

@@ -0,0 +1,103 @@
+import { access, mkdir, readFile, rename, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+
+type StoreResource = {
+  id: string;
+};
+
+type StoreResources<TResources> = {
+  [K in keyof TResources]: StoreResource[];
+};
+
+type EventCatalogStoreFile<TResources> = {
+  version: '1';
+  generatedAt: string;
+  resources: TResources;
+};
+
+type EventCatalogStoreOptions<TResources> = {
+  storePath: string;
+  resources: TResources;
+};
+
+const writeQueues = new Map<string, Promise<void>>();
+
+export class EventCatalogStore<TResources extends StoreResources<TResources>> {
+  static getStorePath(projectDir: string, name: string) {
+    return path.join(projectDir, '.eventcatalog', 'store', `${name}.json`);
+  }
+
+  constructor(private options: EventCatalogStoreOptions<TResources>) {}
+
+  async exists() {
+    try {
+      await access(this.options.storePath);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+
+  async read(): Promise<EventCatalogStoreFile<TResources>> {
+    try {
+      const store = JSON.parse(await readFile(this.options.storePath, 'utf8')) as Partial<EventCatalogStoreFile<TResources>>;
+      return {
+        version: '1',
+        generatedAt: store.generatedAt ?? new Date().toISOString(),
+        resources: this.normalizeResources(store.resources),
+      };
+    } catch {
+      return this.createEmptyStore();
+    }
+  }
+
+  async writeCollection<TKey extends keyof TResources & string>(collection: TKey, resources: TResources[TKey]) {
+    await this.queueWrite(async () => {
+      const store = await this.read();
+      store.generatedAt = new Date().toISOString();
+      store.resources[collection] = [...resources].sort((a, b) => a.id.localeCompare(b.id)) as TResources[TKey];
+
+      await this.write(store);
+    });
+  }
+
+  async clearCollectionIfStoreExists<TKey extends keyof TResources & string>(collection: TKey) {
+    if (!(await this.exists())) return;
+    await this.writeCollection(collection, [] as unknown as TResources[TKey]);
+  }
+
+  private createEmptyStore(): EventCatalogStoreFile<TResources> {
+    return {
+      version: '1',
+      generatedAt: new Date().toISOString(),
+      resources: this.normalizeResources(),
+    };
+  }
+
+  private normalizeResources(resources?: Partial<TResources>): TResources {
+    const normalized = {} as TResources;
+
+    for (const collection of Object.keys(this.options.resources) as (keyof TResources & string)[]) {
+      const value = resources?.[collection];
+      normalized[collection] = (
+        Array.isArray(value) ? value : [...this.options.resources[collection]]
+      ) as TResources[typeof collection];
+    }
+
+    return normalized;
+  }
+
+  private async write(store: EventCatalogStoreFile<TResources>) {
+    await mkdir(path.dirname(this.options.storePath), { recursive: true });
+    await writeFile(`${this.options.storePath}.tmp`, `${JSON.stringify(store, null, 2)}\n`);
+    await rename(`${this.options.storePath}.tmp`, this.options.storePath);
+  }
+
+  private async queueWrite(write: () => Promise<void>) {
+    const previousWrite = writeQueues.get(this.options.storePath) ?? Promise.resolve();
+    const nextWrite = previousWrite.catch(() => undefined).then(write);
+
+    writeQueues.set(this.options.storePath, nextWrite);
+    await nextWrite;
+  }
+}

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
-  "version": "3.43.0",
+  "version": "3.44.0",
   "publishConfig": {
     "access": "public"
   },
@@ -112,9 +112,9 @@
     "update-notifier": "^7.3.1",
     "uuid": "^10.0.0",
     "zod": "^4.3.6",
-    "@eventcatalog/sdk": "2.23.0",
+    "@eventcatalog/linter": "1.0.28",
     "@eventcatalog/visualiser": "^3.22.1",
-    "@eventcatalog/linter": "1.0.26"
+    "@eventcatalog/sdk": "2.24.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.9",