@lupinum/ginko 0.4.0 → 0.6.0

package/dist/shared/ginko.DCHGkQ7P.mjs

@@ -0,0 +1,116 @@
+function seoHead(input) {
+  const { siteName, description, image, noindex } = input;
+  const title = input.title || void 0;
+  const template = input.titleTemplate ?? `%s \xB7 ${siteName}`;
+  const fullTitle = title ? template.replace("%s", () => title) : siteName;
+  const meta = [
+    { name: "description", content: description ?? "" },
+    { name: "robots", content: noindex ? "noindex, follow" : "" },
+    { property: "og:title", content: title ?? siteName },
+    { property: "og:description", content: description ?? "" },
+    { property: "og:type", content: input.type ?? "website" },
+    { property: "og:site_name", content: siteName },
+    { property: "og:image", content: image?.url ?? "" },
+    { property: "og:image:width", content: image?.width === void 0 ? "" : String(image.width) },
+    { property: "og:image:height", content: image?.height === void 0 ? "" : String(image.height) },
+    { property: "og:image:alt", content: image?.alt ?? "" },
+    { name: "twitter:card", content: image ? "summary_large_image" : "summary" }
+  ];
+  return { title: fullTitle, meta: meta.filter((m) => m.content !== "") };
+}
+function isPreviewHost(host, siteUrl) {
+  const bare = (h) => h.toLowerCase().replace(/^www\./, "");
+  return bare(host ?? "") !== bare(new URL(siteUrl).host);
+}
+function robotsTxt(options) {
+  if (options.noindex) return "User-agent: *\nDisallow: /\n";
+  const rules = options.disallow?.length ? options.disallow.map((path) => `Disallow: ${path}`) : ["Allow: /"];
+  const lines = ["User-agent: *", ...rules];
+  if (options.sitemap) lines.push("", `Sitemap: ${options.sitemap}`);
+  return `${lines.join("\n")}
+`;
+}
+const compact = (o) => Object.fromEntries(Object.entries(o).filter(([, v]) => v !== void 0 && v !== "" && !(Array.isArray(v) && v.length === 0)));
+function postalAddressLd(a) {
+  if (!a.street && !a.postalCode && !a.city) return void 0;
+  return compact({ "@type": "PostalAddress", streetAddress: a.street, postalCode: a.postalCode, addressLocality: a.city, addressCountry: a.country });
+}
+function websiteLd(o) {
+  return { "@context": "https://schema.org", "@type": "WebSite", name: o.name, url: o.url, inLanguage: o.lang };
+}
+function withCountry(node, country) {
+  if (!country || node === null || typeof node !== "object") return node;
+  if (Array.isArray(node)) return node.map((item) => withCountry(item, country));
+  const out = Object.fromEntries(Object.entries(node).map(([key, value]) => [key, withCountry(value, country)]));
+  if (out["@type"] === "PostalAddress" && out.addressCountry === void 0) out.addressCountry = country;
+  if (out["@type"] === "JobPosting" && out.jobLocationType === "TELECOMMUTE" && out.applicantLocationRequirements === void 0) {
+    out.applicantLocationRequirements = { "@type": "Country", name: country };
+  }
+  return out;
+}
+const ORGANIZATION_TYPES = ["Organization", "LocalBusiness", "NGO"];
+function organizationLd(o) {
+  return compact({
+    "@context": "https://schema.org",
+    "@type": o.type ?? "Organization",
+    name: o.name,
+    legalName: o.legalName,
+    url: o.url,
+    logo: o.logo,
+    email: o.email,
+    telephone: o.telephone,
+    address: o.address && postalAddressLd(o.address),
+    vatID: o.vatID,
+    sameAs: o.sameAs
+  });
+}
+function breadcrumbJsonLd(steps, siteUrl) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    itemListElement: steps.map((step, i) => ({ "@type": "ListItem", position: i + 1, name: step.title, item: new URL(step.path, siteUrl).href }))
+  };
+}
+function articleLd(o) {
+  const person = (a) => compact({ "@type": "Person", name: a.name, url: a.url });
+  return compact({
+    "@context": "https://schema.org",
+    "@type": o.type ?? "Article",
+    headline: o.title,
+    url: o.url,
+    description: o.description,
+    image: o.image,
+    datePublished: o.published,
+    dateModified: o.modified,
+    author: typeof o.author === "string" ? person({ name: o.author }) : o.author?.map(person),
+    keywords: o.keywords?.join(", "),
+    inLanguage: o.lang
+  });
+}
+function faqLd(pairs) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "FAQPage",
+    mainEntity: pairs.map((p) => ({ "@type": "Question", name: p.question, acceptedAnswer: { "@type": "Answer", text: p.answer } }))
+  };
+}
+function siteHeaders(input) {
+  return {
+    "content-security-policy": input.preview && input.platformOrigin ? `frame-ancestors ${input.platformOrigin}` : `frame-ancestors 'self'`,
+    "x-content-type-options": "nosniff",
+    "referrer-policy": "strict-origin-when-cross-origin",
+    ...input.noindex ? { "x-robots-tag": "noindex" } : {}
+  };
+}
+
+function minorDigits(currency) {
+  return new Intl.NumberFormat("en", { style: "currency", currency }).resolvedOptions().maximumFractionDigits ?? 2;
+}
+function formatMoney(money, language, options = {}) {
+  const digits = minorDigits(money.currency);
+  const whole = options.wholeWithoutMinor === true && money.amount % 10 ** digits === 0;
+  const text = new Intl.NumberFormat(language, { style: "currency", currency: money.currency, ...whole ? { minimumFractionDigits: 0, maximumFractionDigits: 0 } : {} }).format(money.amount / 10 ** digits);
+  return text.replace(/\s/g, "\xA0");
+}
+
+export { ORGANIZATION_TYPES as O, articleLd as a, breadcrumbJsonLd as b, compact as c, faqLd as d, siteHeaders as e, formatMoney as f, withCountry as g, isPreviewHost as i, minorDigits as m, organizationLd as o, postalAddressLd as p, robotsTxt as r, seoHead as s, websiteLd as w };

package/dist/shared/ginko.DIl7l-75.mjs

@@ -0,0 +1,26 @@
+import { w as wordsOf } from './ginko.BNVC-g9n.mjs';
+
+const tail = (brick, id, field) => `${encodeURIComponent(brick)}/${id.split("/").map(encodeURIComponent).join("/")}/${encodeURIComponent(field)}.json`;
+function fileMarkdownRef(locale, brick, id, field) {
+  return `/__ginko/files/${locale}/md/${tail(brick, id, field)}`;
+}
+function platformMarkdownRef(locale, rev, brick, id, field) {
+  return `/__ginko/platform/${locale}/${rev}/md/${tail(brick, id, field)}`;
+}
+function withMarkdownRefs(bundle, schema, trees, refOf) {
+  const swap = (brick, id, data) => {
+    const out = { ...data };
+    for (const [name, field] of Object.entries(schema.bricks[brick]?.fields ?? {})) {
+      const value = out[name];
+      if (field.type !== "markdown" || !value || !("nodes" in value)) continue;
+      const ref = refOf(brick, id, name);
+      trees.set(ref, value);
+      out[name] = { ref, words: wordsOf(value) };
+    }
+    return out;
+  };
+  const bricks = Object.fromEntries(Object.entries(bundle.bricks).map(([key, b]) => [key, b.kind === "single" ? { ...b, data: swap(key, key, b.data) } : { ...b, items: b.items.map((item) => ({ ...item, data: swap(key, item.id, item.data) })) }]));
+  return { ...bundle, bricks };
+}
+
+export { fileMarkdownRef as f, platformMarkdownRef as p, withMarkdownRefs as w };

package/dist/shared/{ginko.akHewCGt.d.mts → ginko.DkIc0ZZk.d.mts}

@@ -1,5 +1,5 @@
-import { b as Msg, S as Schema, F as Fields, J as Json, L as Locale, C as Currency, B as Brick, a as ComponentRegistry, R as RetiredRule, c as Label, d as BrickSource, T as Task, V as Visibility, e as CollectionBrick, f as SingleBrick } from './ginko.D-fNojn9.mjs';
-import { B as Bundle } from './ginko.Bwan3BB-.mjs';
+import { a as Msg, S as Schema, F as Fields, J as Json, L as Locale, C as Currency, H as HolidaysOption, B as Brick, b as ComponentRegistry, R as RetiredRule, c as Label, d as BrickSource, T as Task, V as Visibility, e as CollectionStatus, f as CollectionBrick, g as SingleStatus, h as SingleBrick } from './ginko.DrkUeYFP.mjs';
+import { B as Bundle } from './ginko.6cI8KXZP.mjs';
 
 interface Redirect {
     from: string;
@@ -59,10 +59,12 @@ type Pages = Pick<Schema, 'pages' | 'bricks'>;
 /**
  * The bundle with `$…` links turned into paths and `::snippet` components replaced by their text.
  * `$page.<key>` is a page of `schema.pages`; `$<brick>.<slug-or-id>` is an entry's URL; a `#anchor` is kept.
+ * `main` is the main-language bundle (from `buildBundle`, links unresolved): an entry left out of this locale because
+ * it is not translated (`untranslated: 'hide'`) is found there, and the link goes to its main-language page.
  * What cannot be resolved stays as it is and gets `data-broken: true`. A snippet is the `body` of the entry
  * `snippets/<name>` of the collection `snippets`; a snippet inside a snippet stays as it is. No mutation.
  */
-declare function resolveRouteLinks(bundle: Bundle, schema: Pages): Bundle;
+declare function resolveRouteLinks(bundle: Bundle, schema: Pages, main?: Bundle): Bundle;
 /**
  * Link check over bundles (one per locale) before any HTML exists. Errors: route links and snippets that
  * `resolveRouteLinks` could not resolve, and `/…` paths that match no entry URL, no page and no public file.
@@ -117,6 +119,16 @@ interface SiteInput {
      */
     firstDayOfWeek?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     currency: Currency;
+    /**
+     * The country of the site (ISO 3166-1 alpha-2, e.g. `AT`). It picks the public-holiday calendar (`calendar`) and is
+     * the default `addressCountry` of JSON-LD. A country Ginko has no calendar for keeps no public holidays (`ginko check` warns).
+     */
+    country?: string;
+    /**
+     * Which public holidays count for opening hours: `AT`, `DE` (nationwide only), `SG`, `none`, or your own function
+     * `(year) => Holiday[]`. Default: the calendar of `country`. Stored in the schema as `holidays` (a function as `custom`).
+     */
+    calendar?: HolidaysOption;
     /**
      * Static pages by key: `{ menu: { de: '/speisekarte', en: '/en/menu' } }`. A plain path is the page in
      * the main locale only. The home page is the page whose main-locale path is `/`. The sitemap pairs a page's locales by key.
@@ -136,6 +148,7 @@ interface SiteInput {
         image?: string;
         /** The brand colour, `#rrggbb` or `#rgb`: the background of generated share cards (nuxt-og-image). */
         color?: string;
+        /** The home page's Organization JSON-LD. A page with its own (`siteJsonLd` of `@lupinum/ginko/basics`) gets none from here. */
         organization?: {
             logo?: string;
             sameAs?: string[];
@@ -170,12 +183,40 @@ type RetiredInput<S extends SiteInput> = {
 declare function defineSite<const S extends SiteInput>(site: S & {
     retired?: RetiredInput<S>;
 }): S;
+/**
+ * `site` as it runs on the platform: every brick without `source`, so the owner edits it in the Studio. A template
+ * that reads its content from files and this twin must both pass `checkSite`; tools and tests use it to prove that a
+ * files site can move to the platform without changing its bricks.
+ */
+declare function withoutFiles<const S extends SiteInput>(site: S): WithoutFiles<S>;
+/**
+ * The site for the content source `GINKO_CONTENT` names: unset or empty keeps the config as it is, `platform` is
+ * `withoutFiles(site)`. A files site deployed with `GINKO_CONTENT=platform` reads the Studio without a code change
+ * (the hosted template demos); the Nuxt module and the CLI both read it, so the build and `ginko release` agree.
+ */
+declare function siteForContent(site: SiteInput, content: string | undefined): SiteInput;
+/** `S` with no `source` on any brick. */
+type WithoutFiles<S extends SiteInput> = Omit<S, 'bricks'> & {
+    bricks: {
+        [K in keyof S['bricks']]: Omit<S['bricks'][K], 'source'>;
+    };
+};
 /** The names of the fields in `F` whose type is one of `T`. */
 type FieldsOfType<F, T extends string> = {
     [K in keyof F]: F[K] extends {
         type: T;
     } ? K : never;
 }[keyof F] & string;
+/**
+ * A planned change of one field (`planned`): from the date in the date field `from` on, `next` replaces `field`. `next`
+ * and `from` are optional and set together; every edit task that changes `field` lists them too. Field names only:
+ * a factory with generic fields could not name its date field otherwise, so `ginko check` reports the other rules.
+ */
+type Planned<F> = {
+    field: keyof F & string;
+    next: keyof F & string;
+    from: keyof F & string;
+};
 /** A collection's detail page per locale: a path with `[slug]` where the entry's slug goes, e.g. `/blog/[slug]`. */
 type RouteTemplate = `/${string}[slug]${string}`;
 declare function single<const F extends Fields>(input: {
@@ -185,6 +226,8 @@ declare function single<const F extends Fields>(input: {
     fields: F;
     layout?: 'sections' | 'tabs';
     tasks?: readonly Task<F>[];
+    planned?: Planned<F>;
+    status?: SingleStatus;
 }): SingleBrick<F>;
 declare function collection<const F extends Fields, const R extends Record<Locale, RouteTemplate> | undefined = undefined>(input: {
     label: Label;
@@ -193,6 +236,8 @@ declare function collection<const F extends Fields, const R extends Record<Local
     fields: F;
     layout?: 'sections' | 'tabs';
     tasks?: readonly Task<F>[];
+    /** A planned change of one field: from the date in `from` on, `next` replaces `field`. */
+    planned?: Planned<F>;
     max: number;
     order: 'manual' | {
         field: keyof F & string;
@@ -200,6 +245,10 @@ declare function collection<const F extends Fields, const R extends Record<Local
     };
     route?: R;
     visible?: Visibility<FieldsOfType<F, 'date' | 'daterange'>>;
+    /**
+     * A required translatable field is missing in a language: `'hide'` (default with a `route`) leaves the entry out
+     * there; `'fallback'` (default without) shows the main language and links to the main-language page.
+     */
     untranslated?: 'fallback' | 'hide';
     /** Entries plan weeks of the single brick `brick`; `field` (a date field of this collection) holds the first day of the week (`firstDayOfWeek`). */
     plans?: {
@@ -207,7 +256,9 @@ declare function collection<const F extends Fields, const R extends Record<Local
         field: FieldsOfType<F, 'date'>;
     };
     drafts?: boolean;
+    /** The status line on the Studio's Today page (see `CollectionStatus`). */
+    status?: CollectionStatus<FieldsOfType<F, 'date' | 'daterange'>, keyof F & string>;
 }): CollectionBrick<F, R>;
 
-export { checkLinks as d, collection as e, defineSite as f, entryRedirects as g, externalLinks as h, findRedirect as i, resolveRouteLinks as j, linkTargets as l, matchRedirect as m, redirectProblems as r, single as s };
-export type { CheckLinksOptions as C, ExternalLink as E, LinkConfig as L, Migration as M, Redirect as R, SiteInput as S, LinkIssue as a, MigrationContext as b, RouteTemplate as c };
+export { checkLinks as d, collection as e, defineSite as f, entryRedirects as g, externalLinks as h, findRedirect as i, resolveRouteLinks as j, siteForContent as k, linkTargets as l, matchRedirect as m, redirectProblems as r, single as s, withoutFiles as w };
+export type { CheckLinksOptions as C, ExternalLink as E, LinkConfig as L, Migration as M, RouteTemplate as R, SiteInput as S, WithoutFiles as W, LinkIssue as a, MigrationContext as b, Redirect as c };