@levino/shipyard-base 0.1.2 → 0.3.0

package/{lib → astro}/components/GlobalDesktopNavigation.astro

@@ -1,8 +1,8 @@
 ---
-import type { Config } from '../schemas/config';
-import { cn } from '../tools/cn';
+import type { Config } from "../../schemas/config";
+import { cn } from "../../src/tools/cn";
 
-type Props = Pick<Config, 'brand' | 'navigation'> & { showBrand: boolean };
+type Props = Pick<Config, "brand" | "navigation"> & { showBrand: boolean };
 
 const { brand, navigation, showBrand = false } = Astro.props as Props;
 ---
@@ -29,16 +29,15 @@ const { brand, navigation, showBrand = false } = Astro.props as Props;
           stroke-linecap="round"
           stroke-linejoin="round"
           stroke-width="2"
-          d="M4 6h16M4 12h16M4 18h16"
-        ></path>
+          d="M4 6h16M4 12h16M4 18h16"></path>
       </svg>
     </label>
   </span>
   <div class="flex-1">
     <a
       href="/"
-      class={cn('btn btn-ghost text-xl', {
-        'md:hidden': !showBrand,
+      class={cn("btn btn-ghost text-xl", {
+        "md:hidden": !showBrand,
       })}
     >
       {brand}
@@ -46,26 +45,28 @@ const { brand, navigation, showBrand = false } = Astro.props as Props;
   </div>
   <div class="hidden flex-none lg:flex">
     <ul class="menu menu-horizontal px-1">
-      {Object.entries(navigation).map(([key, entry]) =>
-        entry.subEntry ? (
-          <li>
-            <details>
-              <summary>{entry.label ?? key}</summary>
-              <ul class="rounded-t-none bg-base-100 p-2">
-                {Object.entries(entry.subEntry).map(([key, entry]) => (
-                  <li>
-                    <a href={entry.href}>{entry.label ?? key}</a>
-                  </li>
-                ))}
-              </ul>
-            </details>
-          </li>
-        ) : (
-          <li>
-            <a href={entry.href}>{entry.label ?? key}</a>
-          </li>
+      {
+        Object.entries(navigation).map(([key, entry]) =>
+          entry.subEntry ? (
+            <li>
+              <details>
+                <summary>{entry.label ?? key}</summary>
+                <ul class="rounded-t-none bg-base-100 p-2">
+                  {Object.entries(entry.subEntry).map(([key, entry]) => (
+                    <li>
+                      <a href={entry.href}>{entry.label ?? key}</a>
+                    </li>
+                  ))}
+                </ul>
+              </details>
+            </li>
+          ) : (
+            <li>
+              <a href={entry.href}>{entry.label ?? key}</a>
+            </li>
+          ),
         )
-      )}
+      }
     </ul>
   </div>
 </div>

package/{lib → astro}/components/LocalNavigation.astro

@@ -1,6 +1,6 @@
 ---
-import SidebarElement from './SidebarElement.astro';
-import { Entry } from './types';
+import SidebarElement from "./SidebarElement.astro";
+import type { Entry } from "./types";
 
 interface SidebarProps {
   entry: Entry;

package/astro/components/SidebarNavigation.astro

@@ -0,0 +1,37 @@
+---
+import { cn } from "../../src/tools/cn";
+import SidebarElement from "./SidebarElement.astro";
+import type { Entry } from "./types";
+
+interface Props {
+  local: Entry | undefined;
+  global: Entry;
+  brand: string;
+}
+
+const { local, global, brand } = Astro.props;
+---
+
+<ul class={cn("menu min-h-screen w-56 bg-base-100", { "md:hidden": !local })}>
+  <div>
+    <a href="/" class="btn btn-ghost mb-2 text-xl">
+      {brand}
+    </a>
+  </div>
+  <div class="block md:hidden">
+    <li>
+      {
+        local ? (
+          <details>
+            <summary>Main menu</summary>
+            <SidebarElement entry={global} />
+          </details>
+        ) : (
+          <SidebarElement entry={global} />
+        )
+      }
+    </li>
+    <div class={cn("divider my-1 block md:hidden", { hidden: !local })}></div>
+  </div>
+  {local && <SidebarElement entry={local} />}
+</ul>

package/{lib → astro}/components/TableOfContents.astro

@@ -14,10 +14,6 @@ const { links } = Astro.props as TableOfContentsProps;
 
 <div class="fixed right-0 h-full lg:h-auto lg:overflow-y-visible">
   <div class="w-128 sticky" aria-label="Auf dieser Seite">
-    {links.map((link, key) => (
-      <a href={`#${link.slug}`}>
-        {link.text}
-      </a>
-    ))}
+    {links.map((link) => <a href={`#${link.slug}`}>{link.text}</a>)}
   </div>
 </div>

package/astro/components/index.ts

@@ -0,0 +1,6 @@
+export { default as Footer } from './Footer.astro'
+export { default as GlobalDesktopNavigation } from './GlobalDesktopNavigation.astro'
+export { default as LocalNavigation } from './LocalNavigation.astro'
+export { default as SidebarElement } from './SidebarElement.astro'
+export { default as SidebarNavigation } from './SidebarNavigation.astro'
+export { default as TableOfContents } from './TableOfContents.astro'

package/astro/components/types.ts

@@ -0,0 +1,9 @@
+export type Entry = Record<
+  string,
+  {
+    label?: string
+    href?: string
+    subEntry?: Entry
+    active?: boolean
+  }
+>

package/astro/layouts/Footer.astro

@@ -0,0 +1,14 @@
+---
+import { Footer as FooterComponent } from "../components";
+
+const locale = Astro.currentLocale;
+---
+
+<FooterComponent
+  links={[{ href: `/${locale}/imprint`, label: "Impressum" }]}
+  copyright={{
+    href: "https://github.com/levino",
+    label: "Levin Keller",
+    year: 2023,
+  }}
+/>

package/{lib → astro}/layouts/Page.astro

@@ -1,30 +1,29 @@
 ---
-import Footer from './Footer.astro'
-import '../globals.css'
-import config from 'virtual:shipyard/config'
-import GlobalDesktopNavigation from '../components/GlobalDesktopNavigation.astro'
-import type { NavigationTree, NavigationEntry } from '../schemas/config'
-import { mapObjIndexed } from 'ramda'
-import SidebarNavigation from '../components/SidebarNavigation.astro'
+import Footer from "./Footer.astro";
+import "../../src/globals.css";
+import config from "virtual:shipyard/config";
+import { GlobalDesktopNavigation, SidebarNavigation } from "../components";
+import type { NavigationTree, NavigationEntry } from "../../src/schemas/config";
+import { mapObjIndexed } from "ramda";
 
 type Props = {
   frontmatter?: {
-    title?: string
-    description?: string
-    sidebarNavigation?: NavigationTree
-  }
+    title?: string;
+    description?: string;
+    sidebarNavigation?: NavigationTree;
+  };
 } & {
-  title?: string
-  description?: string
-  sidebarNavigation?: NavigationTree
-}
+  title?: string;
+  description?: string;
+  sidebarNavigation?: NavigationTree;
+};
 
-const locale = Astro.currentLocale || 'de'
-const currentPath = Astro.url.pathname
-const props = Astro.props.frontmatter || Astro.props
+const locale = Astro.currentLocale || "de";
+const currentPath = Astro.url.pathname;
+const props = Astro.props.frontmatter || Astro.props;
 
-const withLocale = (locale: string) => (path: string) => `/${locale}${path}`
-const withCurrentLocale = withLocale(locale)
+const withLocale = (locale: string) => (path: string) => `/${locale}${path}`;
+const withCurrentLocale = withLocale(locale);
 const applyLocaleAndSetActive: (navigation: NavigationTree) => NavigationTree =
   mapObjIndexed((entry: NavigationEntry) => ({
     ...entry,
@@ -33,9 +32,11 @@ const applyLocaleAndSetActive: (navigation: NavigationTree) => NavigationTree =
     ...(entry.subEntry
       ? { subEntry: applyLocaleAndSetActive(entry.subEntry) }
       : {}),
-  }))
+  }));
+
+const navigation = applyLocaleAndSetActive(config.navigation);
+const title =         `${config.title} - ${props.title}`
 
-const navigation = applyLocaleAndSetActive(config.navigation)
 ---
 
 <html>
@@ -44,12 +45,13 @@ const navigation = applyLocaleAndSetActive(config.navigation)
     <link rel="sitemap" href="/sitemap-index.xml" />
     <title>
       {
-        config.meta.title
-          ? `Levin Keller - ${config.meta.title}`
-          : 'Levin Keller'
+        title
       }
     </title>
     <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content={props.description} />
+    <meta property="og:title" content={title} />
+    <meta property="og:description" content={props.description} />
   </head>
   <body>
     <div class="drawer lg:drawer-open">

package/astro/layouts/Splash.astro

@@ -0,0 +1,18 @@
+---
+import type { NavigationTree } from '../../src/schemas/config';
+import Base from './Page.astro'
+
+type Props = {
+  frontmatter?: {
+    title?: string;
+    description?: string;
+    sidebarNavigation?: NavigationTree;
+  };
+}
+
+const props = Astro.props
+---
+
+<Base {...props}>
+  <div class="prose mx-auto"><slot /></div>
+</Base>

package/astro/layouts/index.ts

@@ -0,0 +1,3 @@
+export { default as Footer } from './Footer.astro'
+export { default as Page } from './Page.astro'
+export { default as Splash } from './Splash.astro'

package/package.json

@@ -1,25 +1,26 @@
 {
   "name": "@levino/shipyard-base",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./astro": "./src/astro.ts",
+    "./layouts": "./astro/layouts/index.ts",
+    "./layouts/*": "./astro/layouts/*",
+    "./components": "./astro/components/index.ts",
+    "./components/*": "./astro/components/*"
+  },
   "peerDependencies": {
     "astro": "^5",
     "daisyui": "^4",
     "tailwindcss": "^3",
     "@tailwindcss/typography": "^0.5.10"
   },
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json && rsync -avm --include='*/' --include='*.astro' --include='*.css' --exclude='*' ./src/ ./lib/",
-    "prepublishOnly": "npm run build"
-  },
   "files": [
-    "lib"
+    "astro",
+    "src"
   ],
-  "exports": {
-    ".": "./lib/index.js",
-    "./*": "./lib/*"
-  },
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.10",
     "@types/ramda": "^0.29.9",

package/src/astro.ts

@@ -0,0 +1,2 @@
+export * as components from './astro/components'
+export * as layouts from './astro/layouts'

package/src/index.ts

@@ -0,0 +1,34 @@
+import type { AstroIntegration } from 'astro'
+import type { Config } from './schemas/config'
+export type { Entry } from '../astro/components/types'
+export * from './types'
+export type * from './schemas/config'
+const shipyardConfigId = 'virtual:shipyard/config'
+
+const resolveId: Record<string, string | undefined> = {
+  [shipyardConfigId]: `${shipyardConfigId}`,
+}
+
+const load = (config: Config) =>
+  ({
+    [shipyardConfigId]: `export default ${JSON.stringify(config)}`,
+  }) as Record<string, string | undefined>
+
+export default (config: Config): AstroIntegration => ({
+  name: 'shipyard',
+  hooks: {
+    'astro:config:setup': ({ updateConfig }) => {
+      updateConfig({
+        vite: {
+          plugins: [
+            {
+              name: 'shipyard',
+              resolveId: (id: string) => resolveId[id],
+              load: (id: string) => load(config)[id],
+            },
+          ],
+        },
+      })
+    },
+  },
+})

package/src/schemas/config.ts

@@ -0,0 +1,17 @@
+export interface NavigationEntry {
+  label?: string
+  href?: string
+  subEntry?: NavigationTree
+  active?: boolean
+}
+
+export type NavigationTree = Record<string, NavigationEntry>
+
+export type Config = {
+  brand: string
+  navigation: NavigationTree
+  title: string
+  tagline: string
+  locales: string[]
+  defaultLocale: string
+}

package/src/tools/cn.ts

@@ -0,0 +1,4 @@
+import clsx, { type ClassValue } from 'clsx'
+import { twMerge } from 'tailwind-merge'
+
+export const cn = (...classes: ClassValue[]) => twMerge(clsx(...classes))

package/src/types.ts

@@ -0,0 +1,34 @@
+export interface LinkData {
+  href: string
+  label: string
+  active: boolean
+}
+export const MONTHS_EN = [
+  'january',
+  'february',
+  'march',
+  'april',
+  'may',
+  'june',
+  'july',
+  'august',
+  'september',
+  'october',
+  'november',
+  'december',
+] as const
+
+export const MONTHS_DE = [
+  'Januar',
+  'Februar',
+  'März',
+  'April',
+  'Mai',
+  'Juni',
+  'Juli',
+  'August',
+  'September',
+  'Oktober',
+  'November',
+  'Dezember',
+] as const

package/lib/components/SidebarNavigation.astro

@@ -1,36 +0,0 @@
----
-import { cn } from '../tools/cn';
-import SidebarElement from './SidebarElement.astro';
-import type { Entry } from './types';
-
-interface Props {
-  local?: Entry;
-  global: Entry;
-  brand: string;
-}
-
-
-const { local, global, brand } = Astro.props;
----
-
-<ul class={cn('menu min-h-screen w-56 bg-base-100', { 'md:hidden': !local })}>
-  <div>
-    <a href="/" class="btn btn-ghost mb-2 text-xl">
-      {brand}
-    </a>
-  </div>
-  <div class="block md:hidden">
-    <li>
-      {local ? (
-        <details>
-          <summary>Main menu</summary>
-          <SidebarElement entry={global} />
-        </details>
-      ) : (
-        <SidebarElement entry={global} />
-      )}
-    </li>
-    <div class={cn('divider my-1 block md:hidden', { hidden: !local })} />
-  </div>
-  {local && <SidebarElement entry={local} />}
-</ul>

package/lib/components/types.d.ts

@@ -1,6 +0,0 @@
-export type Entry = Record<string, {
-    label?: string;
-    href?: string;
-    subEntry?: Entry;
-    active?: boolean;
-}>;

package/lib/components/types.js

@@ -1 +0,0 @@
-export {};

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-import type { AstroIntegration } from 'astro';
-import type { Config } from './schemas/config.ts';
-export type { Entry } from './components/types.ts';
-declare const _default: (config: Config) => AstroIntegration;
-export default _default;

package/lib/index.js

@@ -1,25 +0,0 @@
-const shipyardConfigId = 'virtual:shipyard/config';
-const resolveId = {
-    [shipyardConfigId]: `${shipyardConfigId}`,
-};
-const load = (config) => ({
-    [shipyardConfigId]: `export default ${JSON.stringify(config)}`,
-});
-export default (config) => ({
-    name: 'shipyard',
-    hooks: {
-        'astro:config:setup': ({ updateConfig }) => {
-            updateConfig({
-                vite: {
-                    plugins: [
-                        {
-                            name: 'shipyard',
-                            resolveId: (id) => resolveId[id],
-                            load: (id) => load(config)[id],
-                        },
-                    ],
-                },
-            });
-        },
-    },
-});

package/lib/layouts/Footer.astro

@@ -1,14 +0,0 @@
----
-import FooterComponent from '@levino/shipyard-base/components/Footer.astro'
-
-const locale = Astro.currentLocale
----
-
-<FooterComponent
-  links={[{ href: `/${locale}/imprint`, label: 'Impressum' }]}
-  copyright={{
-    href: 'https://github.com/levino',
-    label: 'Levin Keller',
-    year: 2023,
-  }}
-/>

package/lib/layouts/Splash.astro

@@ -1,7 +0,0 @@
----
-import Base from './Page.astro'
----
-
-<Base>
-  <div class="prose mx-auto"><slot /></div>
-</Base>

package/lib/schemas/config.d.ts

@@ -1,15 +0,0 @@
-export interface NavigationEntry {
-    label?: string;
-    href?: string;
-    subEntry?: NavigationTree;
-    active?: boolean;
-}
-export type NavigationTree = Record<string, NavigationEntry>;
-export type Config = {
-    brand: string;
-    navigation: NavigationTree;
-    meta: {
-        title: string;
-        description: string;
-    };
-};

package/lib/schemas/config.js

@@ -1 +0,0 @@
-export {};

package/lib/tools/cn.d.ts

@@ -1,2 +0,0 @@
-import { type ClassValue } from 'clsx';
-export declare const cn: (...classes: ClassValue[]) => string;

package/lib/tools/cn.js

@@ -1,3 +0,0 @@
-import clsx from 'clsx';
-import { twMerge } from 'tailwind-merge';
-export const cn = (...classes) => twMerge(clsx(...classes));

package/lib/types.d.ts

@@ -1,7 +0,0 @@
-export interface LinkData {
-    href: string;
-    label: string;
-    active: boolean;
-}
-export declare const MONTHS_EN: readonly ["january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december"];
-export declare const MONTHS_DE: readonly ["Januar", "Februar", "März", "April", "Mai", "Juni", "Juli", "August", "September", "Oktober", "November", "Dezember"];

package/lib/types.js

@@ -1,28 +0,0 @@
-export const MONTHS_EN = [
-    'january',
-    'february',
-    'march',
-    'april',
-    'may',
-    'june',
-    'july',
-    'august',
-    'september',
-    'october',
-    'november',
-    'december',
-];
-export const MONTHS_DE = [
-    'Januar',
-    'Februar',
-    'März',
-    'April',
-    'Mai',
-    'Juni',
-    'Juli',
-    'August',
-    'September',
-    'Oktober',
-    'November',
-    'Dezember',
-];