@eventcatalog/core 2.0.30 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eventcatalog/core
 
+## 2.1.0
+
+### Minor Changes
+
+- 35fa4a3: feat(core): added ability to customize the landing page
+
+## 2.0.31
+
+### Patch Changes
+
+- c4f6f40: fix(core): discover table width now fixed on long summarys
+
 ## 2.0.30
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.0.30",
+  "version": "2.1.0",
   "publishConfig": {
     "access": "public"
   },

package/scripts/catalog-to-astro-content-directory.js

@@ -187,6 +187,16 @@ export const catalogToAstro = async (source, astroContentDir, catalogFilesDir) =
     pathToAllFiles: [],
     type: 'teams',
   });
+
+  // // Copy all the pages (optional)
+  await copyFiles({
+    source,
+    target: astroContentDir,
+    catalogFilesDir,
+    pathToMarkdownFiles: [path.join(source, 'pages/**/*.md')],
+    pathToAllFiles: [],
+    type: 'pages',
+  });
 };
 
 if (process.env.NODE_ENV !== 'test') {

package/scripts/default-files-for-collections/pages.md

@@ -0,0 +1,5 @@
+---
+id: index
+---
+
+<!-- Do not delete this file, required for EC, you an ignore this file -->

package/scripts/watcher.js

@@ -10,7 +10,7 @@ const catalogDirectory = process.env.CATALOG_DIR;
 
 const contentPath = path.join(catalogDirectory, 'src', 'content');
 
-const watchList = ['domains', 'commands', 'events', 'services', 'teams', 'users'];
+const watchList = ['domains', 'commands', 'events', 'services', 'teams', 'users', 'pages'];
 // const absoluteWatchList = watchList.map((item) => path.join(projectDirectory, item));
 
 // confirm folders exist before watching them

package/src/components/MDX/page-components.tsx

@@ -0,0 +1,8 @@
+const components = {
+  a: (mdxProp: any) => <a className="text-purple-500" {...mdxProp} />,
+  h1: (mdxProp: any) => <h1 className="mb-4" {...mdxProp} />,
+  h3: (mdxProp: any) => <h3 className="mb-2" {...mdxProp} />,
+  p: (mdxProp: any) => <p className="my-3" {...mdxProp} />,
+};
+
+export default components;

package/src/components/Tables/Table.tsx

@@ -90,7 +90,7 @@ export const Table = ({
                 {row.getVisibleCells().map((cell) => (
                   <td
                     key={cell.id}
-                    className={`whitespace-nowrap py-4 pl-4 pr-3 text-sm font-medium text-gray-900  ${cell.column.columnDef.meta?.className}`}
+                    className={` py-4 pl-4 pr-3 text-sm font-medium text-gray-900  ${cell.column.columnDef.meta?.className}`}
                   >
                     {flexRender(cell.column.columnDef.cell, cell.getContext())}
                   </td>

package/src/components/Tables/columns/DomainTableColumns.tsx

@@ -55,6 +55,7 @@ export const columns = () => [
     footer: (info) => info.column.id,
     meta: {
       showFilter: false,
+      className: 'max-w-md',
     },
   }),
   columnHelper.accessor('data.services', {

package/src/components/Tables/columns/MessageTableColumns.tsx

@@ -57,6 +57,7 @@ export const columns = () => [
     footer: (info) => info.column.id,
     meta: {
       showFilter: false,
+      className: 'max-w-md',
     },
   }),
 

package/src/components/Tables/columns/ServiceTableColumns.tsx

@@ -56,6 +56,7 @@ export const columns = () => [
     footer: (info) => info.column.id,
     meta: {
       showFilter: false,
+      className: 'max-w-md',
     },
   }),
   columnHelper.accessor('data.receives', {

package/src/content/config.ts

@@ -1,4 +1,3 @@
-import catalog from '@eventcatalog';
 import { z, defineCollection, reference } from 'astro:content';
 
 const badge = z.object({
@@ -7,6 +6,13 @@ const badge = z.object({
   textColor: z.string(),
 });
 
+const pages = defineCollection({
+  type: 'content',
+  schema: z.object({
+    id: z.string(),
+  }),
+});
+
 // Create a union type for owners
 const ownerReference = z.union([reference('users'), reference('teams')]);
 
@@ -116,4 +122,5 @@ export const collections = {
   users,
   teams,
   domains,
+  pages,
 };

package/src/layouts/DocsLayout.astro

@@ -27,7 +27,7 @@ import SEO from '../components/Seo.astro';
           </div>
         </nav>
 
-        <div class="pl-0 sm:pl-64 lg:pl-72 xl:pl-80 w-full pt-0 pb-40">
+        <div class="pl-0 sm:pl-64 lg:pl-72 xl:pl-80 w-full pt-0 pb-40 ">
           <slot />
         </div>
       </div>

package/src/pages/docs/index.astro

@@ -0,0 +1,40 @@
+---
+import Layout from '@layouts/DocsLayout.astro';
+import DefaultDocsLandingPage from '@layouts/CustomDocsPageLayout.astro';
+import components from '@components/MDX/page-components';
+import { getIndexPage } from '@utils/pages';
+
+const page = await getIndexPage();
+let CustomContent = null;
+
+if(page){
+  const { Content } = await page.render();
+  CustomContent = Content;
+}
+
+---
+
+{CustomContent && 
+  <Layout title="EventCatalog">
+    <main class="py-8">
+      <div class="prose prose-md w-full !max-w-none">
+        <CustomContent components={components}   />
+      </div>
+      <footer class="py-4 space-y-8 border-t border-gray-300">
+        <div class="flex justify-between items-center py-8 text-gray-500 text-sm font-light">
+          <div class="flex space-x-5">
+            <a href="https://github.com/event-catalog/eventcatalog" target="_blank"><svg class="w-5 h-5 bg-gray-400  hover:bg-purple-500 dark:hover:bg-gray-400" style="mask-image: url(&quot;/icons/github.svg&quot;); mask-repeat: no-repeat; mask-position: center center;"></svg></a>
+            <a href="https://x.com/event_catalog" target="_blank"><span class="sr-only">x</span><svg class="w-5 h-5 bg-gray-400  hover:bg-purple-500 dark:hover:bg-gray-400" style="mask-image: url(&quot;/icons/x-twitter.svg&quot;); mask-repeat: no-repeat; mask-position: center center;"></svg></a>
+          </div>
+          <a target="_blank" class="hover:text-purple-500 hover:underline text-gray-400 font-light not-prose" href="https://eventcatalog.dev">Powered by EventCatalog</a>
+        </div>
+      </footer>
+    </main>
+  </Layout>
+}
+
+{!CustomContent && 
+  <DefaultDocsLandingPage title="EventCatalog" />
+}
+
+

package/src/utils/pages.ts

@@ -0,0 +1,15 @@
+import { getCollection } from 'astro:content';
+import type { CollectionEntry } from 'astro:content';
+
+export type Page = CollectionEntry<'pages'>;
+
+export const getPages = async (): Promise<Page[]> => {
+  // Get services that are not versioned
+  const pages = await getCollection('pages');
+  return pages;
+};
+
+export const getIndexPage = async (): Promise<Page> => {
+  const pages = await getCollection('pages');
+  return pages.find((page) => page.slug === 'index')!;
+};

package/src/pages/docs/index.md

@@ -1,4 +0,0 @@
----
-layout: ../../layouts/CustomDocsPageLayout.astro
----
-