@eventcatalog/core 0.0.0 → 0.0.4

package/CHANGELOG.md

@@ -1 +1,19 @@
-# @eventcatalog/core
+# @eventcatalog/core
+
+## 0.0.4
+
+### Patch Changes
+
+- [`1eb4572`](https://github.com/boyney123/eventcatalog/commit/1eb4572918ac06afb64554fef2fc1a3877fbf06d) [#44](https://github.com/boyney123/eventcatalog/pull/44) Thanks [@boyney123](https://github.com/boyney123)! - feat: added more customise options and documentation for them
+
+## 0.0.3
+
+### Patch Changes
+
+- [`23a96fc`](https://github.com/boyney123/eventcatalog/commit/23a96fc651907517cee937657be14cbf9fe95fb9) [#42](https://github.com/boyney123/eventcatalog/pull/42) Thanks [@boyney123](https://github.com/boyney123)! - fix: now remove the .next folder before we start the dev server foric…
+
+## 0.0.2
+
+### Patch Changes
+
+- [`53b27cb`](https://github.com/boyney123/eventcatalog/commit/53b27cb5bb5ab7fa8d526309c6dd50e1f17f3db1) [#39](https://github.com/boyney123/eventcatalog/pull/39) Thanks [@boyney123](https://github.com/boyney123)! - feat: removed ids from services

package/bin/eventcatalog.js

@@ -69,9 +69,10 @@ cli
   .command('dev [siteDir]')
   .description('Start the development server.')
   .action(() => {
-    if (!fs.existsSync(eventCatalogLibDir)) {
-      copyCoreApplicationCodeIntoUsersProjectDir();
-    }
+    // Fix for https://github.com/boyney123/eventcatalog/issues/41, not the best but will do for now
+    fs.rmSync(eventCatalogLibDir, { recursive: true, force: true });
+
+    copyCoreApplicationCodeIntoUsersProjectDir();
 
     // copy any public assets over (from users to the lib itself)
     fs.copySync(path.join(projectDIR, 'public'), path.join(eventCatalogLibDir, 'public'));

package/components/ContentView.tsx

@@ -79,16 +79,19 @@ export default function ContentView({
                           )}
                         </div>
                         <div className="mt-4 flex space-x-3 md:mt-0">
-                          <button
+                          <a
+                            href={editUrl}
+                            target="_blank"
                             type="button"
                             className="hidden md:inline-flex h-10 justify-center px-4 py-2 border border-gray-300 shadow-sm text-sm font-medium rounded-md text-gray-700 bg-white hover:bg-gray-50 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900"
+                            rel="noreferrer"
                           >
                             <PencilIcon
                               className="-ml-1 mr-2 h-5 w-5 text-gray-400"
                               aria-hidden="true"
                             />
                             <span>Edit</span>
-                          </button>
+                          </a>
                         </div>
                       </div>
                       <div className="py-3 xl:pt-6 xl:pb-0">

package/components/Footer.tsx

@@ -2,30 +2,23 @@ import React from 'react';
 import { useConfig } from '@/hooks/EventCatalog';
 
 export default function Footer() {
-  const { organizationName, editUrl } = useConfig();
+  const { organizationName, footerLinks: navigation = [] } = useConfig();
   const year = new Date().getFullYear();
 
-  const navigation = {
-    main: [
-      { name: 'Events', href: '/events' },
-      { name: 'Services', href: '/services' },
-      { name: '3D Node Graph', href: '/overview' },
-      { name: 'GitHub', href: editUrl },
-    ],
-  };
-
   return (
     <footer className="bg-gray-800">
       <div className="max-w-7xl mx-auto py-12 px-4 overflow-hidden sm:px-6 lg:px-8">
-        <nav className="-mx-5 -my-2 flex flex-wrap justify-center" aria-label="Footer">
-          {navigation.main.map((item) => (
-            <div key={item.name} className="px-5 py-2">
-              <a href={item.href} className="text-base text-gray-500 hover:text-gray-900">
-                {item.name}
-              </a>
-            </div>
-          ))}
-        </nav>
+        {navigation && (
+          <nav className="-mx-5 -my-2 flex flex-wrap justify-center" aria-label="Footer">
+            {navigation.map((item) => (
+              <div key={item.label} className="px-5 py-2">
+                <a href={item.href} className="text-base text-gray-500 hover:text-gray-900">
+                  {item.label}
+                </a>
+              </div>
+            ))}
+          </nav>
+        )}
         <p className="mt-8 text-center text-base text-gray-400">
           Copyright © {year} {organizationName}. Built with{' '}
           <a className="underline" href="https://eventcatalog.dev" target="_blank" rel="noreferrer">

package/components/Sidebars/EventSidebar.tsx

@@ -19,8 +19,8 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
     try {
       const res = await fetch(`/api/event/${event.name}/download`);
       if (res.status === 404) throw new Error('Failed to find file');
-      const data = await res.text();
-      fileDownload(data, event.name);
+      const { schema, fileName } = await res.json();
+      fileDownload(schema, fileName);
     } catch (error) {
       // TODO: Maybe better error experince
       console.error(error);

package/lib/__tests__/services.spec.ts

@@ -19,7 +19,6 @@ describe('services', () => {
 
       expect(services).toEqual([
         {
-          id: 'Email Platform',
           name: 'Email Platform',
           summary:
             'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
@@ -65,7 +64,6 @@ describe('services', () => {
 
       expect(services).toEqual([
         {
-          id: 'Email Platform',
           name: 'Email Platform',
           summary:
             'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',
@@ -105,7 +103,6 @@ describe('services', () => {
       const { service, markdown } = await getServiceByName('Email Platform');
 
       expect(service).toEqual({
-        id: 'Email Platform',
         name: 'Email Platform',
         summary:
           'Internal Email system. Used to send emails to 1000s of customers. Hosted in AWS\n',

package/lib/events.ts

@@ -206,8 +206,8 @@ export const getAllEventsThatHaveRelationshipWithService = (
 ): { publishes: Event[]; subscribes: Event[] } => {
   const relationshipsBetweenEvents = events.reduce(
     (data, event) => {
-      const serviceSubscribesToEvent = event.consumers.some((id) => id === service.id);
-      const servicePublishesEvent = event.producers.some((id) => id === service.id);
+      const serviceSubscribesToEvent = event.consumers.some((id) => id === service.name);
+      const servicePublishesEvent = event.producers.some((id) => id === service.name);
 
       return {
         publishes: servicePublishesEvent ? data.publishes.concat(event) : data.publishes,

package/lib/services.ts

@@ -8,8 +8,8 @@ import { MarkdownFile } from '../types/index';
 import { getAllEvents, getAllEventsThatHaveRelationshipWithService } from '@/lib/events';
 
 const buildService = (eventFrontMatter: any): Service => {
-  const { id, name, summary, owners = [], repository = {}, tags = [] } = eventFrontMatter;
-  return { id, name, summary, owners, repository, tags };
+  const { name, summary, owners = [], repository = {}, tags = [] } = eventFrontMatter;
+  return { name, summary, owners, repository, tags };
 };
 
 export const getAllServices = (): Service[] => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventcatalog/core",
-  "version": "0.0.0",
+  "version": "0.0.4",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "react-syntax-highlighter": "^15.4.5"
   },
   "devDependencies": {
-    "@eventcatalog/types": "0.0.0",
+    "@eventcatalog/types": "0.0.2",
     "@types/react": "^17.0.36",
     "autoprefixer": "^10.4.0",
     "commander": "^8.3.0",

package/pages/api/event/[name]/download.js

@@ -8,16 +8,19 @@ export default function (req, res) {
   const eventDir = path.join(process.env.PROJECT_DIR, 'events', eventName);
 
   try {
-    // Find the schema file
     const filesInEventDir = fs.readdirSync(eventDir);
     const schemaFileName = filesInEventDir.find((fileName) => fileName.indexOf('schema.') > -1);
 
     if (schemaFileName) {
+      const extension = schemaFileName.split('.').pop();
       const schemaFile = fs.readFileSync(path.join(eventDir, schemaFileName));
-      res.send(schemaFile).end();
-    } else {
-      res.status(404).end();
+
+      res.send({
+        schema: schemaFile.toString(),
+        fileName: `${eventName}.${extension}`,
+      });
     }
+    res.status(404).end();
   } catch (error) {
     console.log(error);
     res.status(404).end();