@eventcatalog/core 2.2.4 → 2.2.6

package/.github/workflows/verify-build.yml

@@ -11,7 +11,10 @@ jobs:
   build:
     name: Verify Build
     timeout-minutes: 30
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -19,9 +22,5 @@ jobs:
           node-version: '20.x'
       - name: Installation
         run: npm i
-      - name: Log
-        run: ls
-      - name: Log2
-        run: pwd
       - name: Build
         run: npm run verify-build:catalog

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @eventcatalog/core
 
+## 2.2.6
+
+### Patch Changes
+
+- 50a43e0: core(fix): removed forward slash before # to prevent double trailing slash
+- 8104078: chore(core): added windows tests and fixed watcher to work with changelogs files on windows
+
+## 2.2.5
+
+### Patch Changes
+
+- edd58a6: fix(core): enforce the leading slash to the logo
+- 269aef9: fix(core): fixed url paths for EC assets
+
 ## 2.2.4
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.2.4",
+  "version": "2.2.6",
   "publishConfig": {
     "access": "public"
   },
@@ -16,7 +16,7 @@
     "test": "jest --config=$(pwd)/../../jest.config.js",
     "start": "astro dev",
     "build": "npm run scripts:hydrate-content && astro check --minimumSeverity error && astro build",
-    "build:cd": "node scripts/build-ci.js && astro check --minimumSeverity error && astro build",
+    "build:cd": "node scripts/build-ci.js",
     "preview": "astro preview",
     "astro": "astro",
     "scripts:hydrate-content": "node scripts/catalog-to-astro-content-directory.js",

package/scripts/build-ci.js

@@ -16,7 +16,7 @@ fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'ev
 
 fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
 
-execSync(`cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content`, {
+execSync(`cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run build`, {
   cwd: catalogDir,
   stdio: 'inherit',
 });

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

@@ -40,17 +40,19 @@ const copyFiles = async ({ source, target, catalogFilesDir, pathToMarkdownFiles,
 
   // Copy markdown files into the astro content (collection) folder
   for (const file of markdownFiles) {
-    const targetPath = getTargetPath(source, target, type, file);
+    let fileTarget = target;
+
+    // If they are change logs they need to go into their own content folder
+    if (file.includes('changelog.md')) {
+      fileTarget = path.join(target, 'changelogs');
+    }
+
+    const targetPath = getTargetPath(source, fileTarget, type, file);
 
     //ensure the directory exists
     ensureDirSync(path.dirname(targetPath));
 
-    if (file.includes('changelog.md')) {
-      const target = targetPath.replace('/content', '/content/changelogs');
-      fs.cpSync(file, target.replace('changelog.md', 'changelog.mdx'));
-    } else {
-      fs.cpSync(file, targetPath.replace('index.md', 'index.mdx').replace('changelog.md', 'changelog.mdx'));
-    }
+    fs.cpSync(file, targetPath.replace('index.md', 'index.mdx').replace('changelog.md', 'changelog.mdx'));
   }
 
   // Copy all other files (non markdown) files into catalog-files directory (non collection)

package/scripts/watcher.js

@@ -35,6 +35,10 @@ for (let item of [...verifiedWatchList]) {
       // Check if changlogs, they need to go into their own content folder
       if (file.includes('changelog.md')) {
         newPath = newPath.replace('src/content', 'src/content/changelogs');
+
+        if (os.platform() == 'win32') {
+          newPath = newPath.replace('src\\content', 'src\\content\\changelogs');
+        }
       }
 
       // If config files have changes

package/src/components/DocsNavigation.astro

@@ -95,7 +95,7 @@ const currentPath = Astro.url.pathname;
                   {item.items.map((heading: any) => {
                     return (
                       <li class="text-xs">
-                        <a href={`${item.href}/#${heading.slug}`}>{heading.text}</a>
+                        <a href={`${item.href}#${heading.slug}`}>{heading.text}</a>
                       </li>
                     );
                   })}

package/src/components/Header.astro

@@ -21,7 +21,7 @@ const navItems = [
 ];
 
 const logo = {
-  src: catalog?.logo?.src || '/logo.png',
+  src: ('/' + (catalog?.logo?.src || 'logo.png')).replace(/^\/+/, '/'), // replace the leading slashes with a single one
   alt: catalog?.logo?.alt || 'Event Catalog',
   text: catalog?.logo?.text || "EventCatalog"
 }

package/src/components/Seo.astro

@@ -31,7 +31,7 @@ if (typeof _image === 'string') {
 <meta charset="UTF-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <meta name="viewport" content="width=device-width" />
-<link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.ico')} />
+<link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.ico', true)} />
 
 <SEO
 	title={title}

package/src/components/SideBars/MessageSideBar.astro

@@ -59,7 +59,7 @@ const schemaURL = path.join(publicPath, schemaFilePath || '')
       {
         message?.data?.schemaPath && (
           <a
-            href={schemaURL}
+            href={buildUrl(schemaURL, true)}
             download={`${message.data.name}(${message.data.version})-${schemaFilePath}`}
             class="hidden w-full 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-200 bg-gray-800 hover:bg-gray-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900"
           >

package/src/components/SideBars/ServiceSideBar.astro

@@ -60,7 +60,7 @@ const schemaURL = join(publicPath, schemaFilePath || '')
       {
         service?.data?.schemaPath && (
           <a
-            href={schemaURL}
+            href={buildUrl(schemaURL, true)}
             download={`${service.data.name}(${service.data.version})-${schemaFilePath}`}
             class="hidden w-full 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-200 bg-gray-800 hover:bg-gray-600 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-gray-900"
           >

package/src/layouts/CustomDocsPageLayout.astro

@@ -15,7 +15,7 @@ import { buildUrl } from '@utils/url-builder';
     <meta charset="UTF-8" />
     <meta name="description" content="Astro description" />
     <meta name="viewport" content="width=device-width" />
-    <link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.ico')} />
+    <link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.ico', true)} />
     <meta name="generator" content={Astro.generator} />
     <title>EventCatalog</title>
   </head>

package/src/layouts/Footer.astro

@@ -1,11 +1,13 @@
 ---
+import { buildUrl } from "@utils/url-builder"
+
 ---
 
 <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>
+      <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("${buildUrl('/icons/github.svg', true)}"); 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("${buildUrl('/icons/x-twitter.svg', true)}"); 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>

package/src/pages/docs/[type]/[id]/[version]/index.astro

@@ -133,7 +133,7 @@ const badges = [
       <div>
         <!-- @ts-ignore -->
         <SchemaViewer id={props.data.id} catalog={props.catalog}  />
-        <NodeGraph id={props.data.id} collection={props.collection} version={props.data.version} mode="simple" href={{ label: 'Open in Visualiser', url: `/visualiser/${props.collection}/${props.data.id}/${props.data.version}`}} />
+        <NodeGraph id={props.data.id} collection={props.collection} version={props.data.version} mode="simple" href={{ label: 'Open in Visualiser', url: buildUrl(`/visualiser/${props.collection}/${props.data.id}/${props.data.version}`)}} />
       </div>
       <Footer />
     </main>

package/src/pages/docs/[type]/[id]/[version]/spec/index.astro

@@ -10,6 +10,7 @@ import { getDomains } from '@utils/domains/domains';
 import type { CollectionTypes } from '@types';
 import PlainPage from '@layouts/PlainPage.astro';
 import { DocumentMinusIcon } from '@heroicons/react/24/outline';
+import { buildUrl } from '@utils/url-builder';
 
 export async function getStaticPaths() {
   const events = await getEvents();
@@ -42,22 +43,18 @@ const fileExists = fs.existsSync(pathOnDisk);
 ---
 
 <PlainPage title="OpenAPI Spec">
-  <!-- {fileExists && <div>Here</div>} -->
   {
-    !fileExists && (
+    !fileExists ? (
       <div class="text-center h-screen  flex flex-col justify-center ">
-       <DocumentMinusIcon className="mx-auto h-12 w-12 text-gray-400" />
+        <DocumentMinusIcon className="mx-auto h-12 w-12 text-gray-400" />
         <h3 class="mt-2 text-sm font-semibold text-gray-900">No OpenAPI spec file found</h3>
-        <p class="mt-1 text-xs text-gray-400">Could not find OpenAPI file for {data.name} in {`/${catalog.path}`}</p>
-        
+        <p class="mt-1 text-xs text-gray-400">
+          Could not find OpenAPI file for {data.name} in {`/${catalog.path}`}
+        </p>
       </div>
-    )
-  }
-
-  {
-    fileExists && (
+    ) : (
       <rapi-doc
-        spec-url={pathToSpec}
+        spec-url={buildUrl(pathToSpec, true)}
         render-style="table"
         show-header="false"
         allow-authentication="false"