@lupinum/ginko 0.4.0 → 0.5.0

package/dist/basics.d.mts

@@ -0,0 +1,492 @@
+import { B as BasicsOptions, H as HoursContext } from './shared/ginko.plW4dLmm.mjs';
+export { D as DayHours, a as DayRule, E as EventJsonLdInput, b as EventsOptions, c as Exception, d as HolidayClosure, e as HolidayNames, f as HolidaySetting, g as HourPlan, h as HoursData, i as HoursLine, j as HoursLineContext, k as HoursOptions, l as HoursSource, S as SessionJsonLdInput, m as SessionStatus, n as Span, T as Times, o as TodayState, W as Weekday, p as austrianHolidays, q as calendarIn, r as calendarOf, s as closedOnClosure, t as eventJsonLd, u as events, v as germanHolidays, w as holidayOn, x as hourPlans, y as hours, z as hoursLine, A as hoursOn, C as notices, F as noticesOn, G as offerJsonLd, I as planOn, J as sessions, K as sessionsInOrder, L as singaporeHolidays, M as spansOf, N as spansText, O as timesOf, P as todayState, Q as upcomingClosures, R as upcomingHolidayClosures, U as upcomingPlans, V as weekFor, X as weekOf, Y as weekdayOf } from './shared/ginko.plW4dLmm.mjs';
+import { SingleBrick, Locale, CollectionBrick } from './index.mjs';
+import { TextField, LongTextField, SlugField, ChoiceField, DateField, MarkdownField, ImageField, RefField, ListField, FileField } from './internal.mjs';
+export { s as Holiday, t as HolidayCalendar, y as HolidayCalendarName, H as HolidaysOption, u as StoredHolidays, z as calendarOfCountry } from './shared/ginko.DrkUeYFP.mjs';
+import { OrganizationLdInput } from './internal.mjs';
+import { RouteTemplate } from './index.mjs';
+export { w as withoutFiles } from './shared/ginko.DvPtlHIz.mjs';
+import '@lupinum/ginko-i18n/core';
+import 'comark';
+import './shared/ginko.6cI8KXZP.mjs';
+
+declare function site(o?: BasicsOptions): SingleBrick<{
+    legalName: TextField & {
+        readonly hint: Record<string, string>;
+        readonly optional: true;
+        readonly translate: false;
+    };
+    street: TextField & {
+        readonly optional: true;
+        readonly translate: false;
+    };
+    postalCode: TextField & {
+        readonly max: 10;
+        readonly optional: true;
+        readonly translate: false;
+    };
+    city: TextField & {
+        readonly optional: true;
+        readonly translate: false;
+    };
+    email: TextField & {
+        readonly optional: true;
+        readonly format: "email";
+    };
+    phone: TextField & {
+        readonly optional: true;
+        readonly format: "tel";
+        readonly hint: Record<string, string>;
+    };
+    registryNumber: TextField & {
+        readonly optional: true;
+        readonly translate: false;
+    };
+    registryCourt: TextField & {
+        readonly optional: true;
+    };
+    vatId: TextField & {
+        readonly optional: true;
+        readonly translate: false;
+    };
+}>;
+/** The values of a `site()` brick as the site reads them; every one is optional. */
+interface SiteData {
+    legalName?: string;
+    street?: string;
+    postalCode?: string;
+    city?: string;
+    email?: string;
+    phone?: string;
+    registryNumber?: string;
+    registryCourt?: string;
+    vatId?: string;
+}
+interface SiteJsonLdOptions extends Pick<OrganizationLdInput, 'name' | 'url' | 'type' | 'logo' | 'sameAs'> {
+    /** ISO 3166 code such as `DE`, written as `addressCountry`. Default (in `useGinkoSeo`): `country` of the site config. */
+    country?: string;
+}
+/**
+ * schema.org Organization, LocalBusiness or NGO with the address and contact of the `site()` brick. On a page whose
+ * JSON-LD has this node, the Nuxt module does not add its own Organization from `seo.organization`: pass that
+ * config's `logo` and `sameAs` here.
+ */
+declare function siteJsonLd(data: SiteData, o: SiteJsonLdOptions): Record<string, unknown>;
+
+/** The kinds of legal text (`legalType`), in the agency preset's order: stored values, they never change. */
+declare const legalTypes: readonly [{
+    readonly value: "privacy";
+    readonly label: Record<string, string>;
+}, {
+    readonly value: "customer-privacy";
+    readonly label: Record<string, string>;
+}, {
+    readonly value: "imprint";
+    readonly label: Record<string, string>;
+}, {
+    readonly value: "terms";
+    readonly label: Record<string, string>;
+}, {
+    readonly value: "cookies";
+    readonly label: Record<string, string>;
+}, {
+    readonly value: "accessibility";
+    readonly label: Record<string, string>;
+}];
+interface LegalOptions<R extends Record<Locale, RouteTemplate> | undefined> extends BasicsOptions {
+    /** A page per text, e.g. `{ en: '/[slug]', de: '/de/[slug]' }`. Without it the texts have no pages of their own. */
+    route?: R;
+}
+declare function legal<const R extends Record<Locale, RouteTemplate> | undefined = undefined>(o?: LegalOptions<R>): CollectionBrick<{
+    readonly title: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly description: LongTextField & {
+        readonly optional: true;
+    };
+    readonly slug: SlugField & {
+        readonly from: "title";
+    };
+    readonly legalType: ChoiceField<"privacy" | "customer-privacy" | "imprint" | "terms" | "cookies" | "accessibility"> & Omit<{
+        readonly options: readonly [{
+            readonly value: "privacy";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "customer-privacy";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "imprint";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "terms";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "cookies";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "accessibility";
+            readonly label: Record<string, string>;
+        }];
+    }, "options">;
+    readonly updatedAt: DateField & Omit<DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly body: MarkdownField & {
+        readonly translate: "manual";
+    };
+}, R>;
+
+interface PeopleOptions<R extends Record<Locale, RouteTemplate> | undefined> extends BasicsOptions {
+    /**
+     * A page per person, e.g. `{ en: '/speakers/[slug]', de: '/de/vortragende/[slug]' }`. With it, each person gets a
+     * web address (`slug`, made from the name). Without it the stored fields stay as they are.
+     */
+    route?: R;
+}
+declare const slugField: () => SlugField & {
+    readonly from: "name";
+};
+/** The `slug` field when people have pages: its type follows `route`, so `GinkoItem` has `slug` and `url` only then. */
+type SlugOf<R> = R extends undefined ? {} : {
+    slug: ReturnType<typeof slugField>;
+};
+/** People in the owner's order. Files: `content/people/<n>.<name>[.<locale>].md`. */
+declare function people<const R extends Record<Locale, RouteTemplate> | undefined = undefined>(o?: PeopleOptions<R>): CollectionBrick<{
+    readonly name: TextField & {
+        readonly translate: false;
+    };
+    readonly role: TextField & {
+        readonly optional: true;
+    };
+    readonly bio: LongTextField & {
+        readonly optional: true;
+    };
+    readonly email: TextField & {
+        readonly optional: true;
+        readonly format: "email";
+        readonly translate: false;
+    };
+    readonly phone: TextField & {
+        readonly optional: true;
+        readonly format: "tel";
+        readonly translate: false;
+    };
+    readonly photo: ImageField & {
+        readonly optional: true;
+    };
+} & SlugOf<R>, R>;
+interface PersonJsonLdInput {
+    name: string;
+    /** The person's role (`jobTitle`). */
+    role?: string;
+    /** A short bio (`description`). */
+    bio?: string;
+    email?: string;
+    phone?: string;
+    /** Absolute URL of the photo. */
+    image?: string;
+    /** Absolute URL of the person's page or website. */
+    url?: string;
+    /** The organisation the person belongs to (`worksFor`). */
+    worksFor?: {
+        name: string;
+        url?: string;
+    };
+}
+/** schema.org Person, for an entry of `people()` or `authors()`. */
+declare function personJsonLd(p: PersonJsonLdInput): Record<string, unknown>;
+
+interface PostsOptions<R extends Record<Locale, RouteTemplate> | undefined> extends BasicsOptions {
+    /** A page per post, e.g. `{ en: '/blog/[slug]', de: '/de/blog/[slug]' }`. */
+    route?: R;
+    /** Most posts (default 500). */
+    max?: number;
+    /**
+     * The brick the post's `authors` name (default `'authors'`, the shape of `@lupinum/ginko-docs`). A site with a
+     * `people()` brick passes `'people'`, so a writer is one entry for the team page and the byline.
+     */
+    authors?: string;
+}
+/**
+ * Posts, newest first. `authors` names entries of the `authors` brick (add `authors: authors()` to `bricks`), or of
+ * the brick given as the `authors` option (for example `people`).
+ * Files: `content/posts/<name>[.<locale>].md`.
+ */
+declare function posts<const R extends Record<Locale, RouteTemplate> | undefined = undefined>(o?: PostsOptions<R>): CollectionBrick<{
+    readonly title: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly description: LongTextField & {
+        readonly optional: true;
+    };
+    readonly date: DateField & Omit<DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly authors: RefField & {
+        multiple: true;
+    } & {
+        readonly to: string;
+        readonly optional: true;
+    };
+    readonly image: ImageField & {
+        readonly optional: true;
+    };
+    readonly tags: ListField<{
+        readonly tag: TextField & {
+            readonly max: 40;
+        };
+    }> & Omit<{
+        readonly itemLabel: Record<string, string>;
+        readonly fields: {
+            readonly tag: TextField & {
+                readonly max: 40;
+            };
+        };
+        readonly max: 10;
+        readonly optional: true;
+    }, "fields">;
+    readonly slug: SlugField & {
+        readonly from: "title";
+    };
+    readonly body: MarkdownField & {
+        readonly profile: "page";
+    };
+}, R>;
+/** The people who write posts; a post names them in `authors`. Files: `content/authors/<name>[.<locale>].yml`. */
+declare function authors(o?: BasicsOptions): CollectionBrick<{
+    readonly name: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly role: TextField & {
+        readonly optional: true;
+    };
+    readonly avatar: ImageField & {
+        readonly optional: true;
+    };
+    /** Shown as a link on the author's name. */
+    readonly url: TextField & {
+        readonly format: "url";
+        readonly optional: true;
+    };
+}, undefined>;
+interface ChangelogOptions extends BasicsOptions {
+    /** Most entries (default 500). */
+    max?: number;
+}
+/**
+ * One entry per release, newest first. Files: `content/changelog/<name>[.<locale>].md` with `version` and `date` in
+ * the frontmatter (a dot in the name reads as a language: use `v1-2-0.md`).
+ */
+declare function changelog(o?: ChangelogOptions): CollectionBrick<{
+    readonly version: TextField & {
+        readonly max: 40;
+        readonly translate: false;
+    };
+    readonly date: DateField & Omit<DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly body: MarkdownField & {
+        readonly profile: "page";
+    };
+}, undefined>;
+/**
+ * The anchor of a release on a changelog page, a valid id and a stable public address: `4.6.0` → `v4-6-0`
+ * (`/changelog#v4-6-0`). Every site that renders the `changelog` brick uses it, so the addresses stay the same.
+ */
+declare function releaseAnchor(version: string): string;
+interface PostJsonLdInput {
+    title: string;
+    /** Absolute URL of the post. */
+    url: string;
+    /** The post's date (`YYYY-MM-DD`). */
+    date: string;
+    /** When the post last changed (an ISO date or time). */
+    modified?: string;
+    description?: string;
+    /** Absolute URL of the image. */
+    image?: string;
+    /** The post's authors, as the `authors` brick has them; `url` is their website. */
+    authors?: readonly {
+        name: string;
+        url?: string;
+    }[];
+    tags?: readonly string[];
+    /** The language of the post (BCP-47). */
+    lang: string;
+}
+/** schema.org BlogPosting for one post. */
+declare function postJsonLd(p: PostJsonLdInput): Record<string, unknown>;
+
+interface JobsOptions<R extends Record<Locale, RouteTemplate> | undefined> extends BasicsOptions {
+    /** A page per job, e.g. `{ en: '/jobs/[slug]', de: '/de/jobs/[slug]' }`. */
+    route?: R;
+}
+declare function jobs<const R extends Record<Locale, RouteTemplate> | undefined = undefined>(o?: JobsOptions<R>): CollectionBrick<{
+    readonly title: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly description: LongTextField & Omit<LongTextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly slug: SlugField & {
+        readonly from: "title";
+    };
+    readonly location: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly employmentType: ChoiceField<"fullTime" | "partTime" | "freelance" | "internship" | "apprenticeship"> & Omit<{
+        readonly options: readonly [{
+            readonly value: "fullTime";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "partTime";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "freelance";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "internship";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "apprenticeship";
+            readonly label: Record<string, string>;
+        }];
+    }, "options">;
+    readonly remote: ChoiceField<"remote" | "onsite" | "hybrid"> & Omit<{
+        readonly options: readonly [{
+            readonly value: "onsite";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "hybrid";
+            readonly label: Record<string, string>;
+        }, {
+            readonly value: "remote";
+            readonly label: Record<string, string>;
+        }];
+        readonly default: "onsite";
+    }, "options">;
+    readonly applyUrl: TextField & {
+        readonly format: "url";
+        readonly optional: true;
+    };
+    readonly applyEmail: TextField & {
+        readonly format: "email";
+        readonly optional: true;
+    };
+    readonly validUntil: DateField & {
+        readonly hint: Record<string, string>;
+    };
+    readonly body: MarkdownField;
+}, R>;
+interface JobJsonLdInput {
+    title: string;
+    /** Absolute URL of the job's page. */
+    url: string;
+    /** The full description as plain text or HTML (for example the plain text of `body`). */
+    description: string;
+    /** The day the ad went online (`YYYY-MM-DD`). */
+    datePosted: string;
+    /** The last day of the ad (`validUntil`), written as `validThrough`. */
+    validUntil: string;
+    employmentType?: string;
+    /** `remote` marks the job as remote work (`TELECOMMUTE`). */
+    remote?: string;
+    /** The town or city (`location`). */
+    location?: string;
+    /** The employer: the site's name and address. */
+    organization: {
+        name: string;
+        url: string;
+        logo?: string;
+    };
+    /**
+     * ISO 3166 code such as `DE`: `addressCountry`, and where remote applicants must live. Default (in `useGinkoSeo`):
+     * `country` of the site config.
+     */
+    country?: string;
+}
+/** schema.org JobPosting for one job. */
+declare function jobJsonLd(j: JobJsonLdInput): Record<string, unknown>;
+
+declare function faq(o?: BasicsOptions): CollectionBrick<{
+    readonly question: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly answer: LongTextField & Omit<LongTextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+}, undefined>;
+/** schema.org FAQPage for the questions shown on one page. */
+declare function faqJsonLd(items: readonly {
+    question: string;
+    answer: string;
+}[]): Record<string, unknown>;
+
+declare function downloads(o?: BasicsOptions): CollectionBrick<{
+    readonly title: TextField & Omit<TextField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: (string | Partial<Record<string, string>>) | undefined;
+    };
+    readonly summary: LongTextField & {
+        readonly optional: true;
+    };
+    readonly date: DateField & Omit<DateField, "type" | "label" | "pos" | "retired" | "default"> & {
+        default?: string | undefined;
+    };
+    readonly file: FileField & {
+        readonly accept: readonly ["pdf"];
+        readonly maxBytes: number;
+    };
+    readonly language: TextField & {
+        readonly optional: true;
+        readonly translate: false;
+        readonly max: 35;
+        readonly hint: Record<string, string>;
+    };
+}, undefined>;
+
+interface RssItem {
+    title: string;
+    /** Absolute. */
+    link: string;
+    description?: string;
+    /** `YYYY-MM-DD`. */
+    date: string;
+    authors: string[];
+}
+interface RssFeed {
+    title: string;
+    /** Absolute address of the page the feed belongs to. */
+    link: string;
+    /** Absolute address of the feed itself. */
+    self: string;
+    description: string;
+    language: string;
+    items: RssItem[];
+}
+/** Title and description only, as plain text: the feed links to the page for the full post. */
+declare function rssXml(feed: RssFeed): string;
+
+/**
+ * `openingHoursSpecification` (the week that applies `today`) and, when a day within `days` days (default 60) differs
+ * from it, `specialOpeningHoursSpecification`: spread both into a LocalBusiness node.
+ */
+declare function openingHoursJsonLd(ctx: HoursContext, today: string, days?: number): Record<string, unknown>;
+
+declare function gallery(opts?: BasicsOptions): SingleBrick<{
+    readonly images: ListField<{
+        readonly image: ImageField;
+    }> & Omit<{
+        readonly itemLabel: {
+            de: string;
+            en: string;
+        };
+        readonly fields: {
+            readonly image: ImageField;
+        };
+        readonly max: 24;
+        readonly default: readonly [];
+    }, "fields">;
+}>;
+
+export { BasicsOptions, HoursContext, authors, changelog, downloads, faq, faqJsonLd, gallery, jobJsonLd, jobs, legal, legalTypes, openingHoursJsonLd, people, personJsonLd, postJsonLd, posts, releaseAnchor, rssXml, site, siteJsonLd };
+export type { ChangelogOptions, JobJsonLdInput, JobsOptions, LegalOptions, PersonJsonLdInput, PostJsonLdInput, PostsOptions, RssFeed, RssItem, SiteData, SiteJsonLdOptions };