@eventcatalog/core 0.0.3 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @eventcatalog/core
 
+## 0.0.7
+
+### Patch Changes
+
+- [`ee17db8`](https://github.com/boyney123/eventcatalog/commit/ee17db8958ac6368f7d833f0d3ebec2604722e42) [#56](https://github.com/boyney123/eventcatalog/pull/56) Thanks [@boyney123](https://github.com/boyney123)! - feat: changelog.md files now belong inside the versioned folders
+
+## 0.0.6
+
+### Patch Changes
+
+- [`ad66a66`](https://github.com/boyney123/eventcatalog/commit/ad66a66b526a167cc8da43dd2371642c9f9029f2) [#49](https://github.com/boyney123/eventcatalog/pull/49) Thanks [@boyney123](https://github.com/boyney123)! - fix: now supports any extension for event examples also added missing docs
+
+## 0.0.5
+
+### Patch Changes
+
+- [`576debd`](https://github.com/boyney123/eventcatalog/commit/576debdfc5dbc2fbbf98e2b3f4d78b84f9a07669) [#46](https://github.com/boyney123/eventcatalog/pull/46) Thanks [@boyney123](https://github.com/boyney123)! - fix: using cross-env to fix issues with windows OS
+
+## 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

package/bin/eventcatalog.js

@@ -38,7 +38,7 @@ cli
   .command('start [siteDir]')
   .description('Start the development server.')
   .action(() => {
-    execSync(`PROJECT_DIR=${projectDIR} npm run start`, {
+    execSync(`cross-env PROJECT_DIR=${projectDIR} npm run start`, {
       cwd: eventCatalogLibDir,
       stdio: 'inherit',
     });
@@ -56,7 +56,7 @@ cli
     fs.copySync(path.join(projectDIR, 'public'), path.join(eventCatalogLibDir, 'public'));
 
     // build using nextjs
-    execSync(`PROJECT_DIR=${projectDIR} npm run build`, {
+    execSync(`cross-env PROJECT_DIR=${projectDIR} npm run build`, {
       cwd: eventCatalogLibDir,
       stdio: 'inherit',
     });
@@ -82,7 +82,7 @@ cli
       path.join(eventCatalogLibDir, 'eventcatalog.config.js')
     );
 
-    execSync(`PROJECT_DIR=${projectDIR} npm run dev`, {
+    execSync(`cross-env PROJECT_DIR=${projectDIR} npm run dev`, {
       cwd: eventCatalogLibDir,
       stdio: 'inherit',
     });
@@ -103,7 +103,7 @@ cli
       path.join(eventCatalogLibDir, 'eventcatalog.config.js')
     );
 
-    execSync(`PROJECT_DIR=${projectDIR} npm run generate`, {
+    execSync(`cross-env PROJECT_DIR=${projectDIR} npm run generate`, {
       cwd: eventCatalogLibDir,
       stdio: 'inherit',
     });

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/Mdx/Admonition.tsx

@@ -17,7 +17,7 @@ interface AdmonitionProps {
   className?: string;
 }
 
-export default function Admonition({ children, type, className }: AdmonitionProps) {
+export default function Admonition({ children, type, className = '' }: AdmonitionProps) {
   const { color, icon: Icon } = getConfigurationByType(type);
 
   return (

package/components/Sidebars/EventSidebar.tsx

@@ -111,7 +111,7 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
                   ? 'bg-blue-400 text-white shadow-md font-bold underline'
                   : 'bg-blue-100 text-blue-800';
                 return (
-                  <li className="text-sm inline ">
+                  <li className="text-sm inline" key={version}>
                     <Link href={`/events/${eventName}/v/${version}`}>
                       <a>
                         <span

package/components/Sidebars/ServiceSidebar.tsx

@@ -137,7 +137,7 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
           <div className="space-y-3">
             <h2 className="text-sm font-medium text-gray-500">Language</h2>
             {languages.map((value) => (
-              <div className="relative flex items-center mt-2">
+              <div className="relative flex items-center mt-2" key={value}>
                 <div className="absolute flex-shrink-0 flex items-center justify-center">
                   <span
                     className="h-2 w-2 rounded-full"

package/lib/events.ts

@@ -56,7 +56,7 @@ export const getLogsForEvent = (eventName) => {
       let changelog = null;
 
       try {
-        const { content } = readMarkdownFile(path.join(pathToDir, 'changelog.md'));
+        const { content } = readMarkdownFile(path.join(previousVersionPathToDir, 'changelog.md'));
         changelog = content;
       } catch (error) {
         // nothing found it's OK.
@@ -120,7 +120,7 @@ const getEventExamplesFromDir = (pathToExamples) => {
       return {
         name: filename,
         snippet: content,
-        langugage: extentionToLanguageMap[extension],
+        langugage: extentionToLanguageMap[extension] || extension,
       };
     });
   } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventcatalog/core",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "react-syntax-highlighter": "^15.4.5"
   },
   "devDependencies": {
-    "@eventcatalog/types": "0.0.1",
+    "@eventcatalog/types": "0.0.2",
     "@types/react": "^17.0.36",
     "autoprefixer": "^10.4.0",
     "commander": "^8.3.0",
@@ -46,6 +46,7 @@
     "postcss": "^8.3.11",
     "tailwindcss": "^2.2.19",
     "trim": "0.0.3",
+    "cross-env": "^7.0.3",
     "typescript": "^4.4.4"
   },
   "gitHead": "5f82ce7f267e9b3ec771bbd3cc81359ed0a8fd18"

package/pages/_app.tsx

@@ -16,7 +16,7 @@ export default ({ Component, pageProps }: AppProps) => (
         name="description"
         content="An open source project to Discover, Explore and Document your Event Driven Architectures."
       />
-      <meta property="og:url" content="https://demo.eventcatalog.dev/" />
+      <meta property="og:url" content="https://eventcatalog.dev/" />
       <meta property="og:type" content="website" />
       <meta
         property="og:title"
@@ -26,7 +26,7 @@ export default ({ Component, pageProps }: AppProps) => (
         property="og:description"
         content="An open source tool powered by markdown to document your Event Driven Architecture."
       />
-      <meta property="og:image" content="https://demo.eventcatalog.dev/opengraph.png" />
+      <meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png" />
       <meta
         property="og:image:alt"
         content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."

package/pages/events/[name].tsx

@@ -56,7 +56,15 @@ export const getComponents = ({ event, schema, examples }: any) => ({
     );
   },
   Admonition,
-  EventExamples: (props) => <Examples {...props} examples={examples} showLineNumbers />,
+  EventExamples: (props) => {
+    if (examples.length > 0) {
+      return <Examples {...props} examples={examples} showLineNumbers />;
+    }
+    console.log(
+      'You are using the <EventExamples /> component without any examples, please read https://eventcatalog.dev/docs/events/adding-examples for more information'
+    );
+    return null;
+  },
   Mermaid: ({ title }: { title: string }) => (
     <div className="mx-auto w-full py-10">
       {title && <h2 className="text-lg font-medium text-gray-900 underline">{title}</h2>}